HP-UX SNAplus2 R7 NOF Programmer's Guide

NOF API Verbs
QUERY_SESSION
To return information about all sessions without filtering on the partner LU, set both of these parameters to
binary zeros.
This is an 8-byte ASCII string, padded on the right with spaces if the name is shorter than 8 bytes. To specify
that the LU is identified by its LU name rather than its alias, set this parameter to 8 binary zeros and specify
the LU name in the following parameter.
fqplu_name
Fully qualified network name for the partner LU. This parameter is used only if plu_alias is set to 8 binary
zeros; it is ignored otherwise.
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_name
Mode name filter. To return information only about sessions associated with a specific mode, specify the
mode name; the partner LU must also be specified (using one of the two preceding parameters). To return
information about all sessions without filtering on mode name, set this parameter to 8 binary zeros.
The mode name is an 8-byte type-A EBCDIC string, padded on the right with spaces if the name is shorter
than 8 characters.
session_id
8-byte identifier of the session. This parameter is ignored if list_options is set to
AP_FIRST_IN_LIST.
3.157.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:
session_summary.overlay_size
The size of the returned
session_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
session_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.
648