OpenTP1 Version 7 TP1/Client User's Guide TP1/Client/W, TP1/Client/P

[Contents][Index][Back][Next]

4.4.5 dc_clt_set_connect_inf_s - Set terminal identification information

Organization of this subsection
(1) Form
(2) Purpose
(3) Arguments set by UAPs
(4) Return values
(5) Notes

(1) Form

(a) TP1/Client/W
_s version of the function
 
#include <dcvclt.h>
DCLONG dc_clt_set_connect_inf_s(DCCLT_ID cltid,
                                char *inf,
                                unsigned short inf_len,
                                DCLONG flags)
 
Non-_s version of the function
 
#include <dcvclt.h>
DCLONG dc_clt_set_connect_inf(char *inf,
                              unsigned short inf_len,
                              DCLONG flags)
 
(b) TP1/Client/P
_s version of the function
 
#include <dcvclt.h>
DCLONG dc_clt_set_connect_inf_s(DCCLT_ID cltid,
                                char CLTFAR *inf,
                                unsigned short inf_len,
                                DCLONG flags)
 
Non-_s version of the function
 
#include <dcvclt.h>
DCLONG dc_clt_set_connect_inf(char CLTFAR *inf,
                              unsigned short inf_len,
                              DCLONG flags)
 

(2) Purpose

Sets terminal identification information dynamically.

When you use a permanent connection to communicate with a DCCM3 logical terminal, reporting the terminal identification information to the DCCM3 logical terminal allows you to use DCCM3's function for allocating a fixed terminal.

The terminal identification information specified in this function is valid only when the host name and the port number of the DCCM3 logical terminal are specified in the DCCLTRAPHOST client environment definition and DCNOFLAGS is specified in the flags argument of the dc_clt_connect_s function.

When this function is executed, the terminal identification information specified in the DCCLTCONNECTINF client environment definition is not referenced until the the dc_rpc_open_s function is reexecuted.

The terminal identification information specified in this function is referenced by the dc_clt_connect_s function which is executed after this function. These functions then report that information to the DCCM3 logical terminal.

If this function is executed more than once, the dc_clt_connect_s function references the terminal identification information specified immediately before the function.

(3) Arguments set by UAPs

(4) Return values

Return Value Value (decimal) Meaning
DC_OK 0 Normal termination
DCCLTER_INVALID_ARGS -2501 The value specified as the argument is incorrect.
DCCLTER_PROTO -2502 The dc_rpc_open_s function is not executed.
DCCLTER_NO_BUFS -2504 A necessary amount of buffer could not be allocated.
DCCLTER_INVALID_CLTID -2544 The client ID specified in cltid differs from the client ID received by the dc_clt_cltin_s function.

(5) Notes