HP-UX SNAplus2 NOF Programmer's Guide

NOF API Verbs (QUERY Verbs)
QUERY_3270_USER
Chapter 4 509
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 this parameter is specified and
you are running SNAplus2 in a client-server
configuration, the system_name parameter must also
be specified.
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 .
total_num_entries
Total number of entries that could have been returned.
This may be higher than num_entries .
num_entries
The number of entries actually returned.
Each entry in the data buffer consists of the following:
user_3270_summary.overlay_size
The size of the returned user_3270_summary
structure, and therefore the offset to the start of the
next entry in the data buffer.
user_3270_summary.user_name
The name of the 3270 user. This is an ASCII string of
1-32 characters.