HP-UX SNAplus2 R7 NOF Programmer's Guide

NOF API Verbs
QUERY_CONVERSATION
Maximum number of conversations for which data should be returned. To request data for a specific
conversation rather than a range, specify the value 1. To return as many entries as possible, specify zero; in
this case, SNAplus2 will return the maximum number of entries that can be accommodated in the supplied
data buffer.
list_options
The position in the list from which SNAplus2 should begin to return data. Specify one of the following
values:
AP_FIRST_IN_LIST
Start at the first entry in the list.
AP_LIST_INCLUSIVE
Start at the entry specified by the combination of local LU and conversation ID.
AP_LIST_FROM_NEXT
Start at the entry immediately following the entry specified by the combination of local LU and
conversation ID.
The combination of the local LU (
lu_name or lu_alias) and conversation ID (conv_id) specified is used
as an index into the list of sessions if the list_options parameter is set to AP_LIST_INCLUSIVE or
AP_LIST_FROM_NEXT.
For more information about how the list is ordered and how the application can obtain specific entries from
it, see Section 2.7, List Options For QUERY_* Verbs.
lu_name
LU name. This is an 8-byte type-A EBCDIC string, padded on the right with spaces if the name is shorter
than 8 characters. To specify that the LU is identified by its alias rather than its LU name, set this parameter
to 8 binary zeros and specify the LU alias in the following parameter. To specify the LU associated with the
local CP (the default LU), set both lu_name and lu_alias to binary zeros.
lu_alias
Locally defined LU alias. This is an 8-byte ASCII string, padded on the right with spaces if the name is
shorter than 8 bytes. This parameter is used only if lu_name is set to 8 binary zeros; it is ignored otherwise.
To specify the LU associated with the local CP (the default LU), set both lu_name and lu_alias to binary
zeros.
conv_id
Identifier of the conversation for which information is required, or the conversation ID to be used as an index
into the list of conversations. The conversation ID was returned by the ALLOCATE verb in the invoking TP,
or by the RECEIVE_ALLOCATE verb in the invoked TP.
This parameter is ignored if list_options is set to AP_FIRST_IN_LIST.
session_id
8-byte identifier of the session. To list only information about conversations associated with a specific session,
specify the session identifier. To obtain a complete list for all sessions, set this field to binary zeros.
3.99.3 Returned Parameters: Successful Execution
If the verb executes successfully, SNAplus2 returns the following parameters:
primary_rc
AP_OK
buf_size
367