HP-UX SNAplus2 R7 NOF Programmer's Guide

NOF API Verbs
QUERY_FOCAL_POINT
AP_FIRST_IN_LIST
Start at the first entry in the list.
AP_LIST_INCLUSIVE
Start at the entry specified by the ms_category parameter.
AP_LIST_FROM_NEXT
Start at the entry immediately following the entry specified by the ms_category 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.
ms_category
Management Services category. This parameter is not used if list_options is set to AP_FIRST_IN_LIST.
This may be either one of the category names specified in the MS Discipline-Specific Application Programs
table of Systems Network Architecture: Management Services Reference (see Related Publications), padded
with EBCDIC spaces (0x40), or a user-defined category. A user-defined category name is an 8-byte type-
1134 EBCDIC string, padded with EBCDIC spaces (0x40) if necessary.
3.121.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:
fp_data.overlay_size
The size of the returned
fp_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
fp_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.
fp_data.ms_appl_name
Name of the currently active focal point application. This is either one of the MS Discipline-Specific
Application Programs specified in the Systems Network Architecture: Management Services Reference (see
Related Publications), or an EBCDIC string, using type-1134 characters, padded on the right with spaces if
the name is shorter than 8 characters.
457