HP-UX SNAplus2 R7 NOF Programmer's Guide

NOF API Verbs
QUERY_COS_TG_ROW
Start at the first entry in the list.
AP_LIST_INCLUSIVE
Start at the entry specified by the combination of the cos_name and tg_row_index parameters.
AP_LIST_FROM_NEXT
Start at the entry immediately following the entry specified by the combination of the cos_name and
tg_row_index parameters.
The list is ordered by cos_name, and then by tg_row_index for each COS. 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.
cos_name
Class of service name for which data is required, or the name to be used as an index into the list. The name
is an 8-byte type-A EBCDIC string (starting with a letter), padded on the right with EBCDIC spaces if the
name is shorter than 8 characters. This parameter is ignored if list_options is set to
AP_FIRST_IN_LIST.
tg_row_index
TG row number for which data is required, or the number to be used as an index into the list (the
first row
has an index of zero). This parameter is ignored if list_options is set to AP_FIRST_IN_LIST.
3.102.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:
cos_tg_row_data.overlay_size
The size of the returned
cos_tg_row_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
cos_tg_row_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.
cos_tg_row_data.cos_name
Class of service name. This is an 8-byte type-A EBCDIC string (starting with a letter), padded on the right
with EBCDIC spaces if the name is shorter than 8 characters.
378