HP-UX SNAplus2 R7 NOF Programmer's Guide

NOF API Verbs
QUERY_MODE
AP_YES
Return information only on modes for which sessions are currently active.
AP_NO
Return information about all modes for which sessions are active or have been active.
3.137.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:
mode_summary.overlay_size
The size of the returned
mode_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
mode_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.
mode_summary.mode_name
Mode name. This is an 8-byte type-A EBCDIC string, padded on the right with spaces if the name is shorter
than 8 characters.
mode_summary.description
A null-terminated text string describing the mode, as specified in the definition of the mode.
mode_summary.sess_limit
Current session limit.
mode_summary.act_sess_count
Total number of active sessions between the specified local LU and partner LU using the mode.
mode_summary.fqplu_name
Fully qualified name of the partner LU. 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.
mode_detail.overlay_size
546