HP-UX SNAplus2 R7 NOF Programmer's Guide

NOF API Verbs
QUERY_DLUS
The list is ordered by dlus_name. For more information about how the application can obtain specific entries
from the list, see Section 2.7, List Options For QUERY_* Verbs.
dlus_name
Name of the DLUS for which information is required, or the name to be used as an index into the list of
DLUSs. This value is ignored if list_options is set to
AP_FIRST_IN_LIST.
The name is a 17-byte EBCDIC string, right-padded with EBCDIC spaces. It consists of a network ID of
up to 8 A-string characters, an EBCDIC dot (period) character, and a network name of up to 8 A-string
characters.
3.115.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:
dlus_data.overlay_size
The size of the returned
dlus_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
dlus_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.
dlus_data.dlus_name
Name of DLUS. The name is a 17-byte EBCDIC string, right-padded with EBCDIC spaces. It consists of a
network ID of up to 8 A-string characters, an EBCDIC dot (period) character, and a network name of up to
8 A-string characters.
dlus_data.is_default
Specifies whether the DLUS node has been designated as the default by a DEFINE_DLUR_DEFAULTS verb
(
AP_YES or
AP_NO).
dlus_data.is_backup_default
Specifies whether the DLUS node has been designated as the backup default by a DE-
FINE_DLUR_DEFAULTS verb (
AP_YES or AP_NO).
dlus_data.pipe_state
State of the pipe to the DLUS. Possible values are:
429