HP-UX SNAplus2 R7 NOF Programmer's Guide

NOF API Verbs
QUERY_EMULATOR_USER_DEF
unsigned char mode_name[8]; /* Mode name */
unsigned char session_type; /* Session type - display or printer */
} SESSION_5250_DEF_DATA;
3.120.2 Supplied Parameters
The application supplies the following parameters:
opcode
AP_QUERY_EMULATOR_USER_DEF
buf_ptr
A pointer to a data buffer that SNAplus2 will use to return the requested information.
buf_size
Size of the supplied data buffer.
num_entries
Maximum number of users for which data should be returned. If detailed information about user sessions is
being returned, this number includes partial entries (for which a session name is specified, so that the returned
data does not include the user definition or the user’s first session).
To request data for a specific user 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, and the level of information required
for each entry. Specify the level of information with one of the following values:
AP_SUMMARY
Summary information only.
AP_DETAIL
Detailed information.
Combine this value using a logical OR operation with one of the following values:
AP_FIRST_IN_LIST
Start at the first session for the first user in the list.
AP_LIST_INCLUSIVE
Start at the entry specified by the supplied user name and session name, or start at the first session for
the specified user if no session name is specified.
AP_LIST_FROM_NEXT
If a session name is specified, start at the session immediately following the specified session. If no
session name is specified, start at the first session for the specified user.
The list is ordered by user name, and then by session name (irrespective of session type) for each user. 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.
user_name
The name of the user for whom information is required, or the name 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. The name is an ASCII string
of 1–32 characters, padded on the right with spaces if the name is shorter than 32 characters.
452