HP-UX SNAplus2 R7 NOF Programmer's Guide

NOF API Verbs
QUERY_AVAILABLE_TP
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:
available_tp_data.overlay_size
The size of the returned
available_tp_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
available_tp_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.
available_tp_data.tp_name
TP name. This is a 64-byte string, padded on the right with spaces if the name is shorter than 64 characters.
available_tp_data.system_name
Name of the computer where the TP is running.
3.92.4 Returned Parameters: Parameter Check
If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters:
primary_rc
AP_PARAMETER_CHECK
secondary_rc
Possible values are:
AP_INVALID_LIST_OPTION
The list_options parameter was not set to a valid value.
AP_UNKNOWN_TP
The list_options parameter was set to AP_LIST_INCLUSIVE, to list all entries starting from the
supplied name, but the tp_name parameter was not valid.
Appendix B, Common Return Codes lists further secondary return codes associated with
AP_PARAMETER_CHECK,
which are common to all NOF verbs.
3.92.5 Returned Parameters: Other Conditions
Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are
common to all NOF verbs.
351