HP-UX SNAplus2 R7 NOF Programmer's Guide

NOF API Verbs
QUERY_3270_USER
AP_SYSTEM
Return information about 3270 emulation programs running on the specified computer.
AP_USER_AT_SYSTEM
Return information about all 3270 emulation programs running with the specified 3270 user name on
the specified computer.
AP_USER_PROCESS
Return information about a specific copy of the 3270 emulation program, identified by the 3270 user
name, computer name, and process ID.
user_name
The name of the 3270 user for whom information is required, or the name to be used as an index into the
list of users. The user name is an ASCII string of 1–32 characters. This parameter is ignored if
list_options
is set to AP_FIRST_IN_LIST.
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 computer name includes a . (period) character, SNAplus2 assumes that it is a fully-qualified name;
otherwise it performs a DNS lookup to determine the computer 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 the scope
is set to AP_USER_PROCESS.
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).
3.88.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.
total_num_entries
336