HP-UX SNAplus2 R7 NOF Programmer's Guide

NOF API Verbs
QUERY_LOCAL_TOPOLOGY
Number associated with the TG. This value is ignored if list_options is set to AP_FIRST_IN_LIST.
3.126.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:
local_topology_summary.overlay_size
The size of the returned
local_topology_summary
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
local_topology_summary 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() operator. This is because the size of the returned overlay may increase in future releases of
SNAplus2; using the returned overlay size ensures that your application will continue to work with future
releases.
local_topology_summary.dest
Fully qualified destination node name of the TG. The name is a 17-byte EBCDIC string, padded on the
right with EBCDIC spaces. It consists of a network ID of 1–8 A-string characters, an EBCDIC dot (period)
character, and a network name of 1–8 A-string characters.
local_topology_summary.dest_type
Node type of the destination node for this TG. This is one of the following:
AP_NETWORK_NODE
Network node.
AP_VRN
Virtual routing node.
AP_END_NODE
End node or LEN node.
local_topology_summary.tg_num
Number associated with the TG.
local_topology_detail.overlay_size
The size of the returned
local_topology_detail structure, and therefore the offset to the start of the next entry in
the data buffer.
482