HP-UX SNAplus2 R7 NOF Programmer's Guide

NOF API Verbs
QUERY_ADJACENT_NN
Maximum number of adjacent NNs for which data should be returned. To request data for a specific adjacent
NN 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 adjacent NNs 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 adj_nncp_name parameter.
AP_LIST_FROM_NEXT
Start at the entry immediately following the entry specified by the adj_nncp_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.
adj_nncp_name
Fully qualified name of the adjacent NN for which information is required, or the name to be used as an
index into the list of adjacent NNs. This value is ignored if list_options is set to AP_FIRST_IN_LIST.
The name is a 17-byte EBCDIC string, right-padded with EBCDIC spaces. It consists of a network ID of
up to 8 A-string characters, an EBCDIC dot (period) character, and a network name of up to 8 A-string
characters.
3.91.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:
adj_nncp_data.overlay_size
The size of the returned
adj_nncp_data structure, and therefore the offset to the start of the next entry in the
data buffer.
When your application needs to go through the returned buffer to find each
adj_nncp_data structure in turn, it
must use this value to move to the correct offset for the next data structure, and must not use the C sizeof()
347