HP-UX SNAplus2 R7 NOF Programmer's Guide

NOF API Verbs
QUERY_MODE_DEFINITION
3.138.2 Supplied Parameters
The application supplies the following parameters:
opcode
AP_QUERY_MODE_DEFINITION
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 from which SNAplus2 should begin to return data, and the level of information required
for each entry. Specify the level of information with one of the following values:
AP_SUMMARY
Summary information only.
AP_DETAIL
Detailed information.
Combine this value using a logical OR operation with one of the following values:
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 application can obtain specific entries from the list, see Section 2.7, List
Options For QUERY_* Verbs. This verb differs from other QUERY_* verbs in that the modes are listed in
the order they are created.
mode_name
Mode name which designates the network properties for a group of sessions. This parameter is ignored if
list_options is set to AP_FIRST_IN_LIST. This is an 8-byte type-A EBCDIC string, padded on the right
with spaces if the name is shorter than 8 characters.
3.138.3 Returned Parameters: Successful Execution
If the verb executes successfully, SNAplus2 returns the following parameters:
primary_rc
AP_OK
buf_size
551