QUERY_MODE_TO_COS_MAPPING

QUERY_MODE_TO_COS_MAPPING returns information about the mode to COS mapping.

The information is returned as a formatted list. To obtain information about a specific mode, or to obtain the list information in several chunks, the mode_name field should be set.

Otherwise (if the list_options field is set to AP_FIRST_IN_LIST), this field will be ignored. See Querying the Node for background on how the list formats are used.

This list is ordered by the mode_name. Ordering is by name length first, and then by ASCII lexicographical ordering for names of the same length (in accordance with IBM's 6611 APPN® MIB ordering). If AP_LIST_FROM_NEXT is selected, the returned list starts from the next entry according to the defined ordering (whether the specified entry exists or not).

If the default COS (which unknown modes are mapped to) has been overridden using DEFINE_MODE, QUERY_MODE_TO_COS_MAPPING also returns an entry with null mode_name (all zeros) and the default COS. This entry is first in the ordering.

VCB Structure

typedef struct query_mode_to_cos_mapping
{
        unsigned short  opcode;            /* verb operation code        */
        unsigned char   reserv2;           /* reserved                   */
        unsigned char   format;            /* format                     */
        unsigned short  primary_rc;        /* primary return code        */
        unsigned long   secondary_rc;      /* secondary return code      */
        unsigned char   *buf_ptr;          /* pointer to buffer          */
        unsigned long   buf_size;          /* buffer size                */
        unsigned long   total_buf_size;    /* total buffer size required */
        unsigned short  num_entries;       /* number of entries          */
        unsigned short  total_num_entries; /* total number of entries    */
        unsigned char   list_options;      /* listing options            */
        unsigned char   reserv3;           /* reserved                   */
        unsigned char   mode_name[8];      /* mode name                  */
} QUERY_MODE_TO_COS_MAPPING;
typedef struct mode_to_cos_mapping_data
{
        unsigned short  overlay_size;      /* size of this entry         */
        unsigned char   mode_name[8];      /* mode name                  */
        unsigned char   cos_name[8];       /* COS name                   */
        unsigned char   reserva[20];       /* reserved                   */
} MODE_TO_COS_MAPPING_DATA;

Supplied Parameters

The application supplies the following parameters:
opcode
AP_QUERY_MODE_TO_COS_MAPPING
format
Identifies the format of the VCB. Set this field to zero to specify the version of the VCB listed above.
buf_ptr
Pointer to a buffer into which list information can be written. The application can append data to the end of the VCB, in which case buf_ptr must be set to NULL.
buf_size
Size of buffer supplied. The data returned will not exceed this size.
num_entries
Maximum number of entries to return. The number of entries will not exceed this value. A value of zero means no limit.
list_options
This indicates what should be returned in the list information: The mode_name specified (see the following parameter, mode_name) represents an index value that is used to specify the starting point of the actual information to be returned.
AP_FIRST_IN_LIST
The index value is ignored, and the returned list starts from the first entry in the list.
AP_LIST_FROM_NEXT
The returned list starts from the next entry in the list after the one specified by the supplied index value.
AP_LIST_INCLUSIVE
The returned list starts from the entry specified by the index value.
mode_name
Mode name, which designates the network properties for a group of sessions. This is an 8-byte alphanumeric type-A EBCDIC string (starting with a letter), padded to the right with EBCDIC spaces. This field is ignored if list_options is set to AP_FIRST_IN_LIST. This can be set to all zeros to indicate the entry for the default COS.

Returned Parameters

If the verb executes successfully, the Program returns the following parameters:
primary_rc
AP_OK
buf_size
Length of the information returned in the buffer.
total_buf_size
Returned value indicating the size of buffer that would have been required to return all the list information requested. This can be higher than buf_size.
num_entries
Number of entries actually returned.
total_num_entries
Total number of entries that could have been returned. This can be higher than num_entries.
mode_to_cos_mapping_data.overlay_size
The number of bytes in this entry, and hence the offset to the next entry returned (if any).
mode_to_cos_mapping_data.mode_name
8-byte mode name, which designates the network properties for a group of sessions. If this is set to all zeros, it indicates the entry for the default COS.
mode_to_cos_mapping_data.cos_name
Class-of-service name associated with the mode name. This is an 8-byte alphanumeric type-A EBCDIC string (starting with a letter), padded to the right with EBCDIC spaces.
If the verb does not execute because of a parameter error, the Program returns the following parameters:
primary_rc
AP_PARAMETER_CHECK
secondary_rc
AP_INVALID_MODE_NAME

AP_INVALID_LIST_OPTION

If the verb does not execute because the node has not yet been started, the Program returns the following parameter:
primary_rc
AP_NODE_NOT_STARTED
If the verb does not execute because of a system error, the Program returns the following parameter:
primary_rc
AP_UNEXPECTED_SYSTEM_ERROR