HP-UX SNAplus2 R7 NOF Programmer's Guide

NOF API Verbs
QUERY_MODE_TO_COS_MAPPING
3.139.2 Supplied Parameters
The application supplies the following parameters:
opcode
AP_QUERY_MODE_TO_COS_MAPPING
buf_ptr
A pointer to a data buffer that SNAplus2 will use to return the requested information.
buf_size
Size of the supplied data buffer.
num_entries
Maximum number of modes for which data should be returned. To request data for a specific mode rather
than a range, specify the value 1. To return as many entries as possible, specify zero; in this case, SNAplus2
will return the maximum number of entries that can be accommodated in the supplied data buffer.
list_options
The position in the list of modes from which SNAplus2 should begin to return data. Possible values are:
AP_FIRST_IN_LIST
Start at the first entry in the list.
AP_LIST_INCLUSIVE
Start at the entry specified by the mode_name parameter.
AP_LIST_FROM_NEXT
Start at the entry immediately following the entry specified by the mode_name parameter.
For more information about how the list is ordered and how the application can obtain specific entries from
it, see Section 2.7, List Options For QUERY_* Verbs.
mode_name
Mode name for which information is required, or the name to be used as an index into the list. This value is
ignored if list_options is set to AP_FIRST_IN_LIST.
The mode name is an 8-byte type-A EBCDIC string, padded on the right with spaces if the name is shorter
than 8 characters. To return information about the default COS that is used for any unrecognized mode names,
set this parameter to 8 binary zeros.
3.139.3 Returned Parameters: Successful Execution
If the verb executes successfully, SNAplus2 returns the following parameters:
primary_rc
AP_OK
buf_size
Length of the information returned in the supplied buffer.
total_buf_size
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.
num_entries
555