HP-UX SNAplus2 R7 NOF Programmer's Guide

NOF API Verbs
QUERY_LS
ls_name
Link station name. This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter
than 8 characters. This value is ignored if
list_options is set to AP_FIRST_IN_LIST.
port_name
Port name filter. To return information only on LSs associated with a specific port, specify the name of the
port. This is an 8-byte ASCII string), padded on the right with spaces if the name is shorter than 8 characters.
To return information about all LSs without filtering on the port name, set this parameter to 8 binary zeros.
3.129.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:
ls_summary.overlay_size
The size of the returned
ls_summary 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
ls_summary 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.
ls_summary.ls_name
Link station name. This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter
than 8 characters.
ls_summary.description
A null-terminated text string describing the LS, as specified in the definition of the LS.
ls_summary.dlc_type
Type of DLC. This is one of the following:
AP_SDLC
SDLC
AP_X25
QLLC
494