HP-UX SNAplus2 R7 NOF Programmer's Guide

NOF API Verbs
QUERY_DOWNSTREAM_PU
AP_LIST_FROM_NEXT
Start at the entry immediately following the entry specified by the dspu_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.
dspu_name
Name of the PU for which information is required (as specified on DEFINE_LS), or the name to be used as
an index into the list of PUs. This value is ignored if list_options is set to
AP_FIRST_IN_LIST. The name
is an 8-byte EBCDIC type-A string, padded on the right with EBCDIC spaces if the name is shorter than 8
characters.
dspu_services
DSPU services filter. Specifies whether to filter the returned information by the type of services provided to
the PUs. Possible values are:
AP_PU_CONCENTRATION
Return information only on downstream PUs served by PU concentration.
AP_DLUR
Return information only on downstream PUs served by DLUR.
AP_NONE
Return information about all downstream PUs.
3.118.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:
downstream_pu_data.overlay_size
The size of the returned
downstream_pu_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
downstream_pu_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() 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.
443