HP-UX SNAplus2 R7 NOF Programmer's Guide

NOF API Verbs
QUERY_ISR_SESSION
DLUR-maintained sessions are being queried.
AP_ISR_SESSIONS
Regular ISR sessions are being queried.
fqpcid.pcid
Procedure Correlator ID. This is an 8-byte hexadecimal string. This value is ignored if list_options is set to
AP_FIRST_IN_LIST.
fqpcid.fqcp_name
Fully qualified control point name of the session for which information is required, or the name to be used
as an index into the list of sessions. 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.123.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:
isr_session_summary.overlay_size
The size of the returned
isr_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
isr_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.
isr_session_summary.fqpcid.pcid
Procedure Correlator ID.
isr_session_summary.fqpcid.fqcp_name
Fully qualified CP name. 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.
465