HP-UX SNAplus2 R7 NOF Programmer's Guide

NOF API Verbs
QUERY_COS_NODE_ROW
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 COS node rows 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 combination of the cos_name and node_row_index parameters.
AP_LIST_FROM_NEXT
Start at the entry immediately following the entry specified by the combination of the cos_name and
node_row_index parameters.
The list is ordered by cos_name, and then by node_row_index for each COS. For more information about how
the application can obtain specific entries from the list, see Section 2.7, List Options For QUERY_* Verbs.
cos_name
Class of service name for which node row 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 name is an 8-byte type-A
EBCDIC string (starting with a letter), padded on the right with EBCDIC spaces if the name is shorter than
8 characters.
node_row_index
Node row number for which information is required, or the number to be used as an index into the list. This
value is ignored if list_options is set to AP_FIRST_IN_LIST. Use QUERY_COS to determine the number
of node rows associated with this COS.
3.101.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
Number of entries returned in the data buffer.
total_num_entries
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:
cos_node_row_data.overlay_size
The size of the returned
cos_node_row_data structure, and therefore the offset to the start of the next entry in
the data buffer.
374