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

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

4.2.1 dc_clt_cltin_s - client user authentication request

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

(1) Form

(a) TP1/Client/W
_s version of the function
#include <dcvclt.h>
DCLONG dc_clt_cltin_s(HWND hWnd, DCCLT_ID *cltid,
                      char *defpath,
                      char *target_host,
                      char *logname,
                      char *passwd,
                      char *set_host, DCLONG flags)
Non-_s version of the function
#include <dcvclt.h>
int dc_clt_cltin(char *target_host,
                 char *logname,
                 char *passwd,
                 char *set_host, DCLONG flags)
(b) TP1/Client/P
_s version of the function
#include <dcvclt.h>
DCLONG dc_clt_cltin_s(HWND hWnd, DCCLT_ID CLTFAR *cltid,
                      char CLTFAR *defpath,
                      char CLTFAR *target_host,
                      char CLTFAR *logname,
                      char CLTFAR *passwd,
                      char CLTFAR *set_host, DCLONG flags)
Non-_s version of the function
#include <dcvclt.h>
int dc_clt_cltin(char CLTFAR *target_host,
                 char CLTFAR *logname,
                 char CLTFAR *passwd,
                 char CLTFAR *set_host, DCLONG flags)

(2) Purpose

Requests TP1/Server as a gateway to verify the client user specified by the login name.

Always execute the dc_clt_cltin_s function even when you suppress user authentication.

(3) Arguments set by UAPs

(4) Arguments specifying the containers of returned values

(5) Return values

Return Value Value (decimal) Meaning
DC_OK 0 Normal termination
DCCLTER_INVALID_ARGS -2501 Invalid argument
DCCLTER_PROTO -2502 The dc_clt_cltin function has already been issued.
This value is not returned if the dc_clt_cltin_s function is executed.
DCCLTER_FATAL -2503 Channel initialization failed. Or, the client environment is wrongly specified.
DCCLTER_NO_BUFS -2504 A necessary amount of buffer could not be allocated. Alternatively, the resource became insufficient.
DCCLTER_NET_DOWN -2506 Communication fault
DCCLTER_OLTF_NOT_UP -2515 OpenTP1 is not running on the requested service node.
DCCLTER_SYSERR -2518 System error
DCCLTER_REJECT -2527 The specified login name is not registered in the target host, or the password does not match. Alternatively, the OpenTP1 server may not support user authentication. Check whether client_uid_check is specified correctly in the system common definition.
DCCLTER_PORT_IN_USE -2547 A specified port number is in use. Alternatively, port numbers that can be assigned automatically by the operating system are insufficient.

(6) Notes