HP-UX SNAplus2 R7 NOF Programmer's Guide

NOF API Verbs
QUERY_TP_DEFINITION
num_entries
Maximum number of TPs for which data should be returned. To request data for a specific TP 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 from which SNAplus2 should begin to return data, and the level of information required
for each entry. Specify the level of information with one of the following values:
AP_SUMMARY
Summary information only.
AP_DETAIL
Detailed information.
Combine this value using a logical OR operation with one of the following values:
AP_FIRST_IN_LIST
Start at the first entry in the list.
AP_LIST_INCLUSIVE
Start at the entry specified by the tp_name parameter.
AP_LIST_FROM_NEXT
Start at the entry immediately following the entry specified by the tp_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.
tp_name
TP name. This is a 64-byte string, padded on the right with spaces if the name is shorter than 64 characters.
This parameter is ignored if list_options is set to AP_FIRST_IN_LIST.
3.165.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:
684