HP-UX SNAplus2 R7 NOF Programmer's Guide

NOF API Verbs
QUERY_3270_USER_SESSIONS
AP_LIST_INCLUSIVE
Start at the entry specified by the lu_name parameter.
AP_LIST_FROM_NEXT
Start at the entry immediately following the entry specified by the lu_name parameter.
For more information about how the application can obtain specific entries from the list, see Section 2.7, List
Options For QUERY_* Verbs.
user_name
The name of the 3270 user for whom information is required; this is an ASCII string of 1
–32 characters.
This parameter must be specified.
system_name
The computer name for which 3270 user information is required; this is an ASCII string of 1–128 characters.
This parameter is ignored if list_options is set to
AP_FIRST_IN_LIST.
If the node name includes a . (period) character, SNAplus2 assumes that it is a fully-qualified name; otherwise
it performs a DNS lookup to determine the node name.
If you are running SNAplus2 with all programs on a single computer, you can set this parameter to all binary
zeros; there is no need to specify the computer name. Otherwise, if no computer name is specified, SNAplus2
returns the first entry it finds for the specified user name; you do not need to specify the computer name
unless the specified user is using the 3270 emulation program on more than one computer, or unless you also
specify the user_pid parameter.
user_pid
The process ID of the 3270 emulation program for which information is required, or the process ID to be used
as an index into the list of users. This parameter is ignored if list_options is set to AP_FIRST_IN_LIST.
If the SNAplus2 system includes only one server, this parameter is required only if the user is using more
than one copy of the 3270 emulation program. If there are multiple servers and no process ID is specified,
SNAplus2 returns the first entry it finds for the specified user name; you do not need to specify the process
ID unless the specified user is using more than one copy of the 3270 emulation programon the computer
specified by the system_name parameter. If you specify this parameter, you must also specify the system_name
parameter.
If the process ID is not required, set it to 0 (zero).
lu_name
The LU used by the session for which information is required, or the LU name to be used as an index into
the list of sessions. This parameter is ignored if list_options is set to AP_FIRST_IN_LIST. The name is
an 8-character EBCDIC string, padded on the right with EBCDIC spaces if necessary.
3.89.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 buffer.
total_buf_size
Returned value indicating the size of buffer that would have been required to return all the list information
requested. This may be higher than buf_size.
340