|
|
|
|
This verb returns the side information entry for a given symbolic destination name, or for multiple symbolic destination names, depending on the options used.
Note the difference between this verb and the CPI-C function Extract_CPIC_Side_Information. This verb queries a configuration file, so that it returns the default information used by all SNAP-IX CPI-C applications. The CPI-C function queries the application's own copy in memory of the side information table, which the application may have modified using the other CPI-C side information functions.
This verb must be issued to the domain configuration file.
typedef struct query_cpic_side_info
{
AP_UINT16 opcode; /* verb operation code */
unsigned char reserv2; /* reserved */
unsigned char format; /* reserved */
AP_UINT16 primary_rc; /* primary return code */
AP_UINT32 secondary_rc; /* secondary return code */
unsigned char *buf_ptr; /* pointer to buffer */
AP_UINT32 buf_size; /* buffer size */
AP_UINT32 total_buf_size; /* total buffer size required */
AP_UINT16 num_entries; /* number of entries */
AP_UINT16 total_num_entries; /* total number of entries */
unsigned char list_options; /* listing options */
unsigned char reserv3; /* reserved */
unsigned char sym_dest_name[8]; /* Symbolic destination name */
} QUERY_CPIC_SIDE_INFO;
typedef struct cpic_side_info_data
{
AP_UINT16 overlay_size; /* size of returned entry */
unsigned char sym_dest_name[8]; /* Symbolic destination name */
unsigned char reserv1[2]; /* reserved */
CPIC_SIDE_INFO_DEF_DATA def_data;
} CPIC_SIDE_INFO_DATA;
typedef struct cpic_side_info_def_data
{
unsigned char description[32]; /* resource description */
unsigned char reserv1[16]; /* reserved */
CPIC_SIDE_INFO side_info; /* CPIC side info */
unsigned char user_data[24]; /* reserved */
} CPIC_SIDE_INFO_DEF_DATA;
typedef struct cpic_side_info
{
unsigned char partner_lu_name[17]; /* Fully qualified partner */
/* LU name */
unsigned char reserved[3]; /* Reserved */
AP_UINT32 tp_name_type; /* TP name type */
unsigned char tp_name[64]; /* TP name */
unsigned char mode_name[8]; /* Mode name */
AP_UINT32 conversation_security_type; /* Conversation security */
/* type */
unsigned char security_user_id[10]; /* User ID */
unsigned char security_password[10]; /* Password */
unsigned char lu_alias[8]; /* LU alias */
} CPIC_SIDE_INFO;
The application supplies the following parameters:
A pointer to a data buffer that SNAP-IX will use to return the requested information.
Size of the supplied data buffer.
Maximum number of symbolic destination names for which data should be returned. To request data for a specific symbolic destination name rather than a range, specify the value 1. To return as many entries as possible, specify zero; in this case, SNAP-IX will return the maximum number of entries that can be accommodated in the supplied data buffer.
The position in the list of symbolic destination names from which SNAP-IX should begin to return data. Possible values are:
Start at the first entry in the list.
Start at the entry specified by the sym_dest_name parameter.
Start at the entry immediately following the entry specified by the sym_dest_name parameter.
For more information about how the list is ordered and how the application can obtain specific entries from it, see List Options For QUERY_* Verbs.
Symbolic destination name for which data is required, or the name to
be used as an index into the list. This value is ignored if list_options
is set to
If the verb executes successfully, SNAP-IX returns the following parameters:
AP_OK
Length of the information returned in the supplied buffer.
Returned value indicating the size of buffer that would have been required to return all the list information requested. A value greater than buf_size indicates that not all the available entries were returned.
Number of entries returned in the data buffer.
Total number of entries available. A value greater than num_entries indicates that not all the available entries were returned.
Each entry in the data buffer consists of the following parameters:
The size of the returned
When your application needs to go through the returned buffer to find
each
Symbolic destination name for the returned side information entry.
A null-terminated text string describing the side information entry, as specified in the definition of the side information entry.
Fully qualified name of the partner LU. The name is a 17-byte EBCDIC string, right-padded with EBCDIC spaces. It consists of a network ID of up to 8 A-string characters, an EBCDIC dot (period) character, and a network name of up to 8 A-string characters.
The type of the target TP (the valid characters for a TP name are determined by the TP type). Possible values are:
Application TP. All characters in the TP name must be valid ASCII characters.
Service TP. The TP name must be specified as an 8-character ASCII string representing the hexadecimal digits of a 4-character name. For example, if the hexadecimal representation of the name is 0x21F0F0F8, set the def_data.side_info.tp_name parameter to the 8-character string '21F0F0F8'.
The first character (represented by two bytes) must be a hexadecimal value in the range 0x0-0x3F, excluding 0x0E and 0x0F; the remaining characters (each represented by two bytes) must be valid EBCDIC characters.
TP name of the target TP. This is a 64-byte ASCII character string, right-padded with spaces.
Name of the mode used to access the target TP. This is an 8-byte ASCII character string, right-padded with spaces.
Specifies whether the target TP uses conversation security. Possible values are:
The target TP does not use conversation security.
The target TP uses conversation security. The security_user_id and security_password parameters specified below will be used to access the target TP.
As for XC_SECURITY_PROGRAM, except that the local node must not send the password across the network in clear text format. This value can be used only if the remote system supports password substitution.
The target TP uses conversation security, and can accept an
already verified
indicator from the local TP. (This indicates that
the local TP was itself invoked by another TP, and has verified the security
user ID and password supplied by this TP.) The security_user_id
parameter specified below will be used to access the target TP;
no password is required.
User ID used to access the partner TP. This parameter is not used if the conversation_security_type parameter is set to XC_SECURITY_NONE.
Password used to access the partner TP. This parameter is used only if the conversation_security_type parameter is set to XC_SECURITY_PROGRAM or XC_SECURITY_PROGRAM_STRONG .
The alias of the local LU used to communicate with the target TP. This alias is a character string using any locally displayable characters.
If the verb does not execute because of a parameter error, SNAP-IX returns the following parameters:
AP_PARAMETER_CHECK
The list_options parameter was not set to a valid value.
Common Return Codes lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs.
If the verb does not execute because of a state error, SNAP-IX returns the following parameters.
AP_STATE_CHECK
The list_options parameter was set to
Common Return Codes lists further secondary return codes associated with AP_STATE_CHECK, which are common to all NOF verbs.
Common Return Codes lists further combinations of primary and secondary return codes that are common to all NOF verbs.
|
|
|
 |
|