VMS Help System Services, $ICC CONNECT *Conan The Librarian (sorry for the slow response - running on an old VAX) |
Establishes a connection to a remote application over an open association. On Alpha systems, this service accepts 64-bit addresses. Format SYS$ICC_CONNECT ios_icc ,[astadr] ,[astprm] ,assoc_handle ,conn_handle ,remote_assoc ,[remote_node] ,[user_context] ,[conn_buf] ,[conn_buf_len] ,[return_buf] ,[return_buf_len] ,[retlen_addr] ,[flags] C Prototype: int sys$icc_connect (struct _ios_icc *ios_icc, void (*astadr)(__unknown_params), __int64 astprm, unsigned int assoc_handle, unsigned int *conn_handle, void *remote_assoc, void *remote_node, unsigned int user_context, char *conn_buf, unsigned int conn_buf_len, char *return_buf, unsigned int return_buf_len, unsigned int *retlen_addr, unsigned int flags); Arguments ios_icc OpenVMS usage:io_status_block type: quadword (unsigned) access: write only mechanism: by 32-bit or 64-bit reference (Alpha) mechanism: by 32-bit reference (VAX) I/O status block: +2 0 ------------------------------------------------- | Undefined | Completion status | ------------------------------------------------- | ios_icc$l_remstat | ------------------------------------------------- +6 +4 Completion status values: SS$_NORMAL, SS$_BUFFEROVF, SS$_EXQUOTA, SS$_INSFMEM, SS$_IVBUFLEN, SS$_LINKABORT, SS$_LINKDISCON, SS$_NOLOGNAM, SS$_NOSUCHID, SS$_NOSUCHNODE, SS$_PATHLOST, SS$_REJECT, SS$_SSFAIL, SS$_UNREACHABLE, SS$_WRONGSTATE The second longword is undefined unless the completion code is SS$_REJECT. In this case, the application-defined rejection reason code is supplied by the server when $ICC_REJECT is called. astadr OpenVMS usage:ast_procedure type: procedure_entry_mask access: call without stack unwinding mechanism: by 32-bit or 64-bit linkage reference (Alpha) mechanism: by 32-bit reference (VAX) The AST routine to be executed when the operation completes. astprm OpenVMS usage:user_arg type: quadword (unsigned) (Alpha), longword (unsigned) (VAX) access: read only mechanism: by 64-bit value (Alpha) mechanism: by 32-bit value (VAX) The parameter to be passed to the AST routine. assoc_handle OpenVMS usage:association_id type: longword (unsigned) access: read only mechanism: by value The handle of the association on which the connection is to be opened. The constant ICC$C_DFLT_ASSOC_HANDLE, if used, indicates that the default association is to be used (and opened if necessary). conn_handle OpenVMS usage:longword_unsigned type: longword (unsigned) access: write only mechanism: by 32-bit or 64-bit reference (Alpha) mechanism: by 32-bit reference (VAX) The 32-bit or 64-bit address (on Alpha systems) or the 32-bit address (on VAX systems) of a longword into which $ICC_CONNECT writes the connection handle of the created connection on a successful call. remote_assoc OpenVMS usage:char_string type: character-coded text string access: read only mechanism: by 32-bit or 64-bit descriptor (Alpha) mechanism: by 32-bit descriptor (VAX) An ASCII character string (31 characters maximum) specifying the name of the target application to connect to. Association names are case sensitive. remote_node OpenVMS usage:char_string type: character-coded text string access: read only mechanism: by 32-bit or 64-bit descriptor (Alpha) mechanism: by 32-bit descriptor (VAX) The name of the node where the target association resides. A null or blank string can be used to indicate the local node. If omitted (by passing zero by value), the simple clusterwide association registry is to be used. Each node name is a one-to- six character SCS node name. A comma-delimited list of nodes may be specified, indicating that one is to be chosen at random. user_context OpenVMS usage:user_arg type: longword (unsigned) (VAX), quadword (Alpha) access: read only mechanism: by value A user-specified value to be subsequently returned on any disconnect or data events on this connection. conn_buf OpenVMS usage:byte_stream type: character-coded text string access: read only mechanism: by 32-bit or 64-bit reference (Alpha) mechanism: by 32-bit reference (VAX) A buffer of up to 1000 bytes of connection data to be sent to the target of the connection during the connection process. conn_buf_len OpenVMS usage:buffer_length type: longword (unsigned) access: read only mechanism: by value The number of bytes in conn_buf to be sent. return_buf OpenVMS usage:byte_stream type: character-coded text string access: read only mechanism: by 32-bit or 64-bit reference (Alpha) mechanism: by 32-bit reference (VAX) A buffer of up to 1000 bytes in length to receive any incoming connection accept or reject data returned. return_buf_len OpenVMS usage:buffer_length type: longword (unsigned) access: read only mechanism: by value The length of the supplied return_buf. retlen_addr OpenVMS usage:longword_unsigned type: longword (unsigned) access: write only mechanism: by 32-bit or 64-bit reference (Alpha) mechanism: by 32-bit reference (VAX) The 32-bit or 64-bit address (on Alpha systems) or the 32-bit address (on VAX systems) of a longword into which $ICC_CONNECT writes the actual length (in bytes) of any user accept or reject data returned in the buffer return_buf. flags OpenVMS usage:mask_longword type: longword (unsigned) access: read only mechanism: by value ICC$M_SYNCH_MODE can be specified to indicate that the data transmission and reception routines $ICC_TRANSMIT, $ICC_RECEIVE, and $ICC_REPLY are allowed to return the status SS$_SYNCH in the case of synchronous completion, indicating that the AST will not be called.
|