 |
- RequestStruct
- Pointer to the CEATsoRequestStruct structure. The layout of
the CEATsoRequestStruct structure follows:
struct CEATsoRequestStruct_s {
char ceatso_eyecatcher[8];
uint32_t ceatso_version;
uint32_t ceatso_requesttype;
char ceatso_userid[8];
uint32_t ceatso_asid;
char ceatso_logonproc[8];
char ceatso_command[80];
uint16_t ceatso_numqueryreq;
uint16_t ceatso_numqueryrslt;
uint32_t ceatso_duration;
uint32_t ceatso_msgqueueid;
uint16_t ceatso_charset;
uint16_t ceatso_codepage;
uint16_t ceatso_screenrows;
uint16_t ceatso_screencols;
char ceatso_account[40];
char ceatso_group[8];
char ceatso_region[7];
char ceatso_instance[1];
char ceatso_apptag[8];
char ceatso_stoken[8];
uint32_t ceatso_ascbaddr;
uint16_t ceatso_flags;
uint16_t ceatso_index;
char rsvd1[8];
};
typedef struct CEATsoRequestStruct_s CEATsoRequestStruct_t;
The
fields in the CEATsoRequestStruct structure are explained as follows:
- ceatso_eyecatcher
- Eye catcher. Specify ‘CEAYTSOR’.
- ceatso_version
- Structure version number.
- ceatso_requesttype
- Type of request. Specify one of the following values:
- CeaTsoStart
- CeaTsoAttn
- CeaTsoEnd
- CeaTsoPing
- CeaTsoQuery
- CeaTsoQueryApp
For more details about each request type, see Understanding the request types.
- ceatso_userid
- User ID of the authenticated user for which the TSO/E address
space was created.
- ceatso_asid
- The address space ID (ASID) for the TSO/E address space.
- ceatso_logonproc
- Name of the TSO/E logon procedure to use to log onto the TSO/E
address space.
- ceatso_command
- Unused.
- ceatso_numqueryreq
- Maximum number of sessions to query.
- ceatso_numqueryrslt
- Number of sessions found that satisfy the query.
- ceatso_duration
- Unused.
- ceatso_msgqueueid
- The ID of the z/OS® UNIX message queue that is used
for communications between the caller and the TSO/E session.
- ceatso_charset
- Character set to use for the caller’s TSO/E address space.
This value is used by the applications running in the TSO/E address
space to convert messages and responses from UTF-8 to EBCDIC.
The default character set, which is 697 decimal, will be used if zero
is specified as the value.
- ceatso_codepage
- Codepage to use for the caller’s TSO/E address space. This
value is used by the applications running in the TSO/E address space
to convert messages and responses from UTF-8 to EBCDIC. The
default codepage, which is 1047 decimal, will be used if zero is specified
as the value.
- ceatso_screenrows
- Number of rows to be displayed on the screen. The default number
of rows, which is 24, will be used if zero is specified as the value.
- ceatso_screencols
- Number of columns to be displayed on the screen. The default
number of columns, which is 80, will be used if zero is specified
as the value.
- ceatso_account
- TSO/E account number.
- ceatso_group
- TSO/E group name.
- ceatso_region
- Region size used for the TSO/E address space.
- ceatso_instance
- Number of active TSO/E address spaces that were started by CEA
for the corresponding user ID. In the session table, this value is
stored with the oldest TSO/E session entry created for the user.
- ceatso_apptag
- Identifies the application that is responsible for creating
the TSO/E address space.
- ceatso_stoken
- A token that uniquely identifies the TSO/E address space.
- ceatso_ascbaddr
- Address of the address space control block that was created
for the TSO/E address space.
- ceatso_flags
- When ending a TSO/E session, you can set the following flags:
- CEATSO_ABLOGOFF (0x8000). If this flag is
set, the CANCEL command will be issued to end the TSO/E session regardless
of whether the CEA reconnect feature is enabled. Otherwise, the LOGOFF
command will be issued or the TSO/E session will be placed in a dormant
state as a candidate for reconnection.
- CEATSO_NORECONN (0x4000). If this flag is
set, the CEA TSO/E address space manager will end the TSO/E session
even if the CEA reconnect feature is enabled. That is, if the client
allows users to set this flag, users can force the CEA TSO/E address
space manager to end a TSO/E session even if your installation has
enabled the reconnect feature. For more information about the reconnect
feature, see Reconnecting to CEA TSO/E address spaces.
When starting a TSO/E session, the CEA TSO/E address space
manager sets the CEATSO_RECONNECTD (0x2000) flag if the user was connected
to a dormant TSO/E session instead of a new session.
- ceatso_index
- The index value, STOKEN, and ASID together identify the TSO/E
address space to the CEA TSO/E address space services.
- rsvd1
- Reserved for future use.
- QueryStruct
- Pointer to the CEATsoQueryStruct structure. This structure
is used to return query results for the CeaTsoQuery and CeaTsoQueryApp
request types. The layout of the CEATsoQueryStruct structure follows:
struct CEATsoQueryStruct_s{
char ceatsoq_eyecatcher[8];
uint32_t ceatsoq_version;
uint32_t ceatsoq_requesttype;
char ceatsoq_userid[8];
uint32_t ceatsoq_asid;
char ceatsoq_logonproc[8];
char ceatsoq_command[80];
uint16_t ceatsoq_numqueryreq;
uint16_t ceatsoq_numqueryrslt;
uint32_t ceatsoq_duration;
uint32_t ceatsoq_msgqueueid;
uint16_t ceatsoq_charset;
uint16_t ceatsoq_codepage;
uint16_t ceatsoq_screenrows;
uint16_t ceatsoq_screencols;
char ceatsoq_account[40];
char ceatsoq_group[8];
char ceatsoq_region[7];
char ceatsoq_instance[1];
char ceatsoq_apptag[8];
char ceatsoq_stoken[8];
uint32_t ceatsoq_ascbaddr;
uint16_t ceatsoq_flags;
uint16_t ceatsoq_index;
char rsvd1[8];
};
typedef struct CEATsoQueryStruct_s CEATsoQueryStruct_t;
The
fields in the CEATsoQueryStruct structure are explained as follows:
- ceatso_eyecatcher
- Eye catcher. The value is ‘CEAYTSOQ’.
- ceatso_version
- Structure version number.
- ceatso_requesttype
- Type of request. The CeaTsoQueryStruct returns results for the
CeaTsoQuery and CeaTsoQueryApp request types. For more details about
each request type, see Understanding the request types.
- ceatso_userid
- User ID of the authenticated user for which the TSO/E address
space was created.
- ceatso_asid
- The address space ID (ASID) for the TSO/E address space.
- ceatso_logonproc
- Name of the TSO/E logon procedure to use to log onto the TSO/E
address space.
- ceatso_command
- Unused.
- ceatso_numqueryreq
- Maximum number of sessions to query.
- ceatso_numqueryrslt
- Number of sessions found that satisfy the query.
- ceatso_duration
- Unused.
- ceatso_msgqueueid
- The ID of the z/OS UNIX message queue that is used
for communications between the caller and the TSO/E session.
- ceatso_charset
- Character set to use for the caller’s TSO/E address space.
This value is used by the applications running in the TSO/E address
space to convert messages and responses from UTF-8 to EBCDIC.
The default character set, which is 697 decimal, will be used if zero
is specified as the value.
- ceatso_codepage
- Codepage to use for the caller’s TSO/E address space. This
value is used by the applications running in the TSO/E address space
to convert messages and responses from UTF-8 to EBCDIC. The
default codepage, which is 1047 decimal, will be used if zero is specified
as the value.
- ceatso_screenrows
- Number of rows to be displayed on the screen. The default number
of rows, which is 24, will be used if zero is specified as the value.
- ceatso_screencols
- Number of columns to be displayed on the screen. The default
number of columns, which is 80, will be used if zero is specified
as the value.
- ceatso_account
- TSO/E account number.
- ceatso_group
- TSO/E group name.
- ceatso_region
- Region size used for the TSO/E address space.
- ceatso_instance
- Number of active TSO/E address spaces that were started by CEA
for the corresponding user ID. In the session table, this value is
stored with the oldest TSO/E session entry created for the user.
- ceatso_apptag
- Identifies the application that is responsible for creating
the TSO/E address space.
- ceatso_stoken
- A token that uniquely identifies the TSO/E address space.
- ceatso_ascbaddr
- Address of the address space control block that was created
for the TSO/E address space.
- ceatso_flags
- When ending a TSO/E session, you can set the following flags:
- CEATSO_ABLOGOFF (0x8000). If this flag is
set, the CANCEL command will be issued to end the TSO/E session regardless
of whether the CEA reconnect feature is enabled. Otherwise, the LOGOFF
command will be issued or the TSO/E session will be placed in a dormant
state as a candidate for reconnection.
- CEATSO_NORECONN (0x4000). If this flag is
set, the CEA TSO/E address space manager will end the TSO/E session
even if the CEA reconnect feature is enabled. That is, if the client
allows users to set this flag, users can force the CEA TSO/E address
space manager to end a TSO/E session even if your installation has
enabled the reconnect feature. For more information about the reconnect
feature, see Reconnecting to CEA TSO/E address spaces.
When starting a TSO/E session, the CEA TSO/E address space
manager sets the CEATSO_RECONNECTD (0x2000) flag if the user was connected
to a dormant TSO/E session instead of a new session.
- ceatso_index
- The index value, STOKEN, and ASID together identify the TSO/E
address space to the CEA TSO/E address space services.
- rsvd1
- Reserved for future use.
- ErrorStruct
Pointer to the CEATsoErrorStruct structure. This structure
contains information about the results of the request. The layout
of the CEATsoErrorStruct structure follows: struct CEATsoError_s {
char eyeCatcher[8];
uint32_t version;
int32_t returnCode;
uint32_t reasonCode;
CEATsoDiag_t diag;
};
typedef struct CEATsoError_s CEATsoError_t;
The fields
in the CEATsoErrorStruct structure are explained as follows:
- eyeCatcher
- Eye catcher. Specify ‘CEAIERRO’.
- version
- Structure version number.
- returnCode
- Return code. For more information about return codes, see Return codes.
- reasonCode
- Reason code. For more information about reason codes, see Reason codes.
- diag
- Diagnostic codes, which are mapped by a CEATsoDiag_t structure.
This structure can contain up to four diagnostic codes that provide
more details about the failure. For more information about diagnostic
codes, see Diagnostic codes.
|
z/OS MVS Programming: Callable Services for High-Level Languages
Copyright IBM Corporation 1990, 2014