ANSI C, C++

#include <dcmcf.h> int dc_mcf_tlsle (DCLONG action, dcmcf_tlsleopt *leopt, char *resv01, DCLONG *resv02, char *resv03, DCLONG *infcnt, dcmcf_leinf2 *inf, char *resv04)

K&R C

#include <dcmcf.h> int dc_mcf_tlsle (action, leopt, resv01, resv02, resv03, infcnt, inf, resv04) DCLONG action; dcmcf_tlsleopt *leopt; char *resv01; DCLONG *resv02; char *resv03; DCLONG *infcnt; dcmcf_leinf2 *inf; char *resv04;

The dc_mcf_tlsle() function acquires the status of a logical terminal.

action

Specify DCMCFLE to indicate that a logical terminal name is to be specified.

leopt

Set in a dcmcf_tlsleopt structure the connection information about the logical terminal 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
                char      resv02[7];    ...Reserved
                char      resv03[112];  ...Reserved
                char      resv04[376];  ...Reserved
                } dcmcf_tlsleopt;
 

• mcfid
  Specify the MCF communication process identifier of the MCF communication service for the logical terminal that is to be processed. The permitted value range is from 0 to 239.
  If you specify 0, the system searches for the MCF communication service to which the specified logical terminal name belongs. In a configuration where many MCF communication services are running or when you issue this function many times from a UAP, we recommend that you specify the MCF communication process identifier.
  
• resv01
  Fill the area with null characters.
  
• idnam
  Specify the name of the logical terminal whose status is to be acquired. The logical terminal name must be specified as a maximum of 8 bytes of characters and must end with the null character.
  
• resv02, resv03, resv04
  Fill the areas with null characters.
  

resv01, resv02, resv03

Specify NULL.

infcnt

Specify 1 as the number of dcmcf_leinf2 areas for storing the logical terminal status.

When the processing is completed, the number of corresponding logical terminals is returned.

inf

Specify a dcmcf_leinf2 area for storing the logical terminal status information.

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

resv04

Specify NULL.

infcnt

Returns the number of logical terminals that were processed by this function.

inf

Returns the dcmcf_leinf2 structure containing the information about the logical terminal that was processed by this function.

The following shows the format of the structure:

 
typedef struct {
                char      idnam[9];    ...Logical terminal name
                char      resv01[7];   ...Reserved
                char      resv02[4];   ...Reserved
                DCLONG    status;      ...Logical terminal status
                char      resv03[40];  ...Reserved
                } dcmcf_leinf2;
 

• idnam
  Sets the name of the requested logical terminal.
  
• resv01, resv02
  Fills the areas with null characters.
  
• status
  Sets one of the following values as the status of the requested logical terminal:
  

  DCMCF_LEST_ACT

  Logical terminal has been released from shutdown status.

  DCMCF_LEST_DCT

  Logical terminal has been shut down.

• resv03
  Fills the area with null characters.
  

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