dc_mcf_tlscn - Acquire a connection status

Format

ANSI C, C++

#include <dcmcf.h>
int dc_mcf_tlscn (DCLONG action, dcmcf_tlscnopt *cnopt,
char *resv01, DCLONG *resv02,
char *resv03, DCLONG *infcnt,
dcmcf_cninf *inf, char *resv04)

K&R C

#include <dcmcf.h>
int dc_mcf_tlscn (action, cnopt, resv01, resv02, resv03, infcnt,
inf, resv04)
DCLONG action;
dcmcf_tlscnopt *cnopt;
char *resv01;
DCLONG *resv02;
char *resv03;
DCLONG *infcnt;
dcmcf_cninf *inf;
char *resv04;

Description

The dc_mcf_tlscn() function acquires the status of a connection.

Arguments whose values are set in the UAP

action

Specify in one of the following formats the method used to specify the connection whose status is to be acquired:

{DCMCFLE|DCMCFCN}

DCMCFLE
Specifies that a logical terminal name is specified for the connection whose status is to be acquired.
This argument is not supported by TP1/NET/NCSB or TP1/NET/X25-Extended.
DCMCFCN
Specifies that a connection ID is specified for the connection whose status is to be acquired.

cnopt

Set in a dcmcf_tlscnopt structure the information about the connection that is to be the subject to this function's processing.

The following shows the format of the structure:

typedef struct {
               DCLONG    mcfid;        ...MCF communication
                                          process identifier
               char      resv01[4];    ...Reserved
               char      idnam[9];     ...Logical terminal name
                                          or connection ID
               char      resv02[7];    ...Reserved
               char      resv03[112];  ...Reserved
               char      resv04[376];  ...Reserved
               } dcmcf_tlscnopt;

resv01, resv02, resv03

Specify NULL.

infcnt

Specify 1 as the number of dcmcf_cninf areas to be used to store connection status.

When the processing is completed, the number of corresponding connections is returned.

inf

Specify the dcmcf_cninf area for storing the connection status.

The size of this area must be at least the size of the dcmcf_cninf structure x infcnt.

resv04

Specify NULL.

Arguments whose values are returned from OpenTP1

infcnt

Returns the number of connections that were processed by this function.

inf

Returns the dcmcf_cninf structure containing the information about the connection that was processed by this function.

The following shows the format of the structure:

typedef struct {
               char     idnam[9];      ...Connection ID
               char     resv01[7];     ...Reserved
               char     pnam[4];       ...Protocol type
               DCLONG   status;        ...Connection status
               char     resv02[40];    ...Reserved
               } dcmcf_cninf;

Return values

Return valueReturn value (numeric)Explanation
DCMCFRTN_000000Normal termination.
DCMCFRTN_71001-12001The dc_mcf_tlscn() function cannot be accepted because the MCF is under start processing.
DCMCFRTN_71004-12004A memory shortage occurred during dc_mcf_tlscn() function processing.
DCMCFRTN_71005-12005A communication error occurred. For the cause, see the message log file.
DCMCFRTN_71006-12006An internal error occurred. For the cause, see the message log file.
DCMCFRTN_71007-12007The specified connection name has not been registered.
DCMCFRTN_71008-12008The specified logical terminal name has not been registered.
DCMCFRTN_71009-12009The dc_mcf_tlscn() function is not supported by the applicable MCF communication process.
DCMCFRTN_71010-12010Although the request to acquire the connection status was issued to the MCF communication process, the request was not accepted. For the cause, see the message log file.
DCMCFRTN_71011-12011The dc_mcf_tlscn() function cannot be accepted because the connection has been deleted.
DCMCFRTN_71014-12014The specified logical terminal name belongs to TP1/NET/NCSB or TP1/NET/X25-Extended; or, the specified connection group name belongs to TP1/NET/OSI-TP or TP1/NET/TCP/IP.
DCMCFRTN_72050-13050An unsupported flag is set in action.
DCMCFRTN_72051-13051NULL is set in cnopt.
DCMCFRTN_72052-13052NULL is not set in resv01.
DCMCFRTN_72053-13053NULL is not set in resv02.
DCMCFRTN_72054-13054NULL is not set in resv03.
DCMCFRTN_72055-13055NULL is not set in resv04.
DCMCFRTN_72056-13056NULL is set in infcnt.
DCMCFRTN_72057-13057NULL is set in inf.
DCMCFRTN_72060-13060DCMCFLE and DCMCFCN cannot be specified together in action.
DCMCFRTN_72061-13061A value smaller than 0 or a value 240 or greater is specified for mcfid in dcmcf_tlscnopt.
DCMCFRTN_72062-13062resv01 in dcmcf_tlscnopt is not filled with null characters.
DCMCFRTN_72063-13063idnam in dcmcf_tlscnopt begins with the null character.
DCMCFRTN_72064-13064resv02 in dcmcf_tlscnopt is not filled with null characters.
DCMCFRTN_72065-13065resv03 in dcmcf_tlscnopt is not filled with null characters.
DCMCFRTN_72067-13067resv04 in dcmcf_tlscnopt is not filled with null characters.
DCMCFRTN_72073-13073The character string set in idnam in dcmcf_tlscnopt is 9 or more bytes in length.
DCMCFRTN_72074-13074The character string set in idnam in dcmcf_tlscnopt contains an invalid character.
DCMCFRTN_72076-13076The value 1 is not set in infcnt.