HP-UX SNAplus2 R7 NOF Programmer's Guide

NOF API Verbs
QUERY_EMULATOR_USER_DEF
Specifies whether the information for the last user is incomplete. Possible values are:
AP_YES
The complete data for the last user was too large to fit in the data buffer. At least one session structure
is included, but there are further session structures that are not included in the data buffer. The
num_last_sessions parameter indicates how many session structures have been returned; the application
can issue further verbs to obtain the remaining data.
AP_NO
The data for the last user is complete.
Each entry in the data buffer consists of the following:
emulator_user_summary.overlay_size
The size of the returned
emulator_user_summary structure, and therefore the offset to the start of the next entry
in the data buffer.
When your application needs to go through the returned buffer to find each
emulator_user_summary structure
in turn, it must use this value to move to the correct offset for the next data structure, and must not use the
C
sizeof() operator. This is because the size of the returned overlay may increase in future releases of
SNAplus2; using the returned overlay size ensures that your application will continue to work with future
releases.
emulator_user_summary.user_name
The name of the user or group. This is an ASCII string of 1–32 characters.
emulator_user_detail.overlay_size
The size of the returned
emulator_user_detail structure, and therefore the offset to the start of the next entry in
the data buffer.
When your application needs to go through the returned buffer to find each
emulator_user_detail structure in
turn, it must use this value to move to the correct offset for the next data structure, and must not use the
C sizeof() operator. This is because the size of the returned overlay may increase in future releases of
SNAplus2; using the returned overlay size ensures that your application will continue to work with future
releases.
emulator_user_detail.sub_overlay_offset
The offset to the start of the first session data structure for this user in the data buffer.
emulator_user_detail.user_name
The name of the user or group. This is an ASCII string of 1–32 characters.
emulator_user_detail.num_filtered_sessions
The total number of sessions for this user of the type(s) specified by emulator_type.Ifemulator_type was
set to
AP_NONE, this parameter is zero.
emulator_user_detail.def_data
The details of the user, as defined in the configuration. This is followed by a number of session structures,
defining the user’s sessions and the user’s remap list. The format of this information is the same as for the
DEFINE_EMULATOR_USER verb, except for the following:
• The sub_overlay_size parameter in the
def_data structure specifies the size of each returned
session_def_data
structure, and therefore the offset to the start of the next entry in the data buffer.
When your application needs to go through the returned buffer to find each
session_def_data structure in
turn, it must use this value to move to the correct offset for the next data structure, and must not use the
C sizeof() operator. This is because the size of the returned overlay may increase in future releases of
SNAplus2; using the returned overlay size ensures that your application will continue to work with future
releases.
454