HP-UX SNAplus2 R7 NOF Programmer's Guide

NOF API Verbs
QUERY_EMULATOR_USER_DEF
session_name
To return information starting with a specific session name for the specified user, set this parameter to the
session name. To return information starting at the first session for the specified user, set this parameter to 8
binary zeros.
emulator_type
Specify whether to filter the returned information by session type. Possible values are:
AP_3270_SESSION
Return only information about 3270 sessions.
AP_5250_SESSION
Return only information about 5250 sessions.
AP_ALL
Return information about all sessions regardless of session type.
AP_NONE
Do not return any
session_def_data structures. This value can be used with list_options set to
AP_DETAIL, to obtain detailed information about the user configuration but to suppress detailed
information about individual sessions.
3.120.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
Total number of entries that could have been returned. This may be higher than num_entries.
num_entries
The number of entries actually returned. The last entry may be incomplete; this is indicated by the
last_user_incomplete parameter.
num_init_sessions
If the session_name parameter was set to a nonzero value, so that the information for the first user in the list
does not start with the user’s first session, this parameter indicates the number of session structures for this
user that are included in the returned data. Otherwise, this parameter is not used.
num_last_sessions
If the last_user_incomplete parameter indicates that the data for the last user is incomplete, this parameter
indicates the number of session structures for this user that are included in the returned data. (The
num_filtered_sessions parameter returned for this user indicates the total number of session structures of
the requested type that are available.) Otherwise, this parameter is not used.
last_user_incomplete
453