HP-UX SNAplus2 R7 NOF Programmer's Guide

NOF API Verbs
QUERY_CPIC_SIDE_INFO
opcode
AP_QUERY_CPIC_SIDE_INFO
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 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, 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 symbolic destination names 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 sym_dest_name parameter.
AP_LIST_FROM_NEXT
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 Section 2.7, List Options For QUERY_* Verbs.
sym_dest_name
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 AP_FIRST_IN_LIST. The name is an ASCII string, consisting of
uppercase A–Z and numerals 0–9, padded on the right with spaces if the name is shorter than 8 characters.
3.103.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.
383