HP-UX SNAplus2 R7 NOF Programmer's Guide
NOF API Verbs
QUERY_EMULATOR_USER_DEF
3.119.5 Returned Parameters: Other Conditions
Appendix B, Common Return Codes lists further combinations of primary and secondary return codes that are
common to all NOF verbs.
3.120 QUERY_EMULATOR_USER_DEF
QUERY_EMULATOR_USER_DEF returns information about 3270 users or 5250 users defined in a SNAplus2
configuration file. It can return either summary or detailed information, about a single user or multiple users,
depending on the options used. This verb returns information about the definition of this user in the configuration
file, not about the user’s current usage of the emulation program. You can use QUERY_3270_USER and
QUERY_3270_USER_SESSIONS to obtain information about a user’s current 3270 emulation usage.
This verb must be issued to the domain configuration file.
3.120.1 VCB Structure
typedef struct query_emulator_user_def
{
AP_UINT16 opcode; /* verb operation code */
unsigned char reserv2; /* reserved */
unsigned char format; /* reserved */
AP_UINT16 primary_rc; /* primary return code */
AP_UINT32 secondary_rc; /* secondary return code */
unsigned char *buf_ptr; /* pointer to buffer */
AP_UINT32 buf_size; /* buffer size */
AP_UINT32 total_buf_size; /* total buffer size required */
AP_UINT16 num_entries; /* number of entries */
AP_UINT16 total_num_entries; /* total number of entries */
unsigned char list_options; /* listing options */
unsigned char reserv3; /* reserved */
unsigned char user_name[32]; /* 3270 user name */
unsigned char session_name[8]; /* session name */
unsigned char emulator_type; /* type of entries to return */
unsigned char reserv4; /* reserved */
AP_UINT32 num_init_sessions; /* number of sessions for first */
/* user when starting in middle */
AP_UINT32 num_last_sessions; /* number of sessions on last */
/* detail overlay if last user */
/* is incomplete */
unsigned char last_user_incomplete; /* set to AP_YES if session */
/* data for last user incomplete */
} QUERY_EMULATOR_USER_DEF;
typedef struct emulator_user_summary
{
AP_UINT16 overlay_size; /* overlay size */
unsigned char user_name[32]; /* user name */
unsigned char reserv4[4]; /* reserved */
} EMULATOR_USER_SUMMARY;
typedef struct emulator_user_detail
{
AP_UINT16 overlay_size; /* overlay size */
450