QUERY_3270

QUERY_3270_DIAG returns information about the 3270 diagnostics parameters for the SNAplus2 system. It always returns information about the parameters used to record and display response-time data; depending on the options used, it can also return data on a 3270 user alert that users can send to the host NetView program, or on multiple alerts.

This verb must be issued to the domain configuration file. If 3270 diagnostics parameters have not been defined, the verb returns the default parameters that SNAplus2 uses for response-time data; no alert definitions are returned.

VCB Structure

typedef struct query_3270_diag
{
    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                   */
    AP_UINT16           alert_number;          /* index into alerts          */
    DIAG_3270_DATA      def_data;
} QUERY_3270_DIAG;

typedef struct diag_3270_data
{
    unsigned char       rtm_overflow;          /* Send RTM data at counter   */
                                               /*  overflow                  */
    unsigned char       rtm_unbind;            /* Send RTM data at UNBIND    */
    unsigned char       rtm_timer_option;      /* RTM timers option          */
    unsigned char       reserv1;               /* reserved                   */
    AP_UINT16           rtm_thresh1;           /* RTM threshold #1           */
    AP_UINT16           rtm_thresh2;           /* RTM threshold #2           */
    AP_UINT16           rtm_thresh3;           /* RTM threshold #3           */
    AP_UINT16           rtm_thresh4;           /* RTM threshold #4           */
    AP_UINT16           num_alerts;            /* Number of user alerts      */
} DIAG_3270_DATA;

typedef struct alert_3270_data
{
    unsigned char       description[53];       /* description                */
    unsigned char       parameter1[33];        /* parameter 1                */
    unsigned char       parameter2[33];        /* parameter 2                */
    unsigned char       parameter3[33];        /* parameter 3                */
} ALERT_3270_DATA;

Supplied Parameters

The application supplies the following parameters:

opcode

AP_QUERY_3270_DIAG

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 3270 user alerts for which data should be returned. To request data for a specific alert 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 of alerts from which SNAplus2 should begin to return data. Specify one of the following values:

AP_FIRST_IN_LIST: Start at the first entry in the list.
AP_LIST_INCLUSIVE: Start at the entry specified by the alert_number parameter.
AP_LIST_FROM_NEXT: Start at the entry immediately following the entry specified by the alert_number parameter.

For more information about how the application can obtain specific entries from the list, see “List Options For QUERY_* Verbs”.

If no alerts have been defined, this parameter must be set to AP_FIRST_IN_LIST.

alert_number

The number of the alert for which information is required, or the number to be used as an index into the list of alerts. This is a number in the range 1-20; it is ignored if list_options is set to AP_FIRST_IN_LIST.

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 alert entries that could have been returned. This may be higher than num_entries.
num_entries: The number of alert entries actually returned.
diag_3270_data: Data structure containing 3270 diagnostics information. The format of this information is the same as for the DEFINE_3270_DIAG verb.

For each alert, up to the number specified in num_entries, an alert_3270_data structure is included. The format of the information in this structure is the same as for the DEFINE_3270_DIAG verb.

Returned Parameters: Parameter Check

If the verb does not execute because of a parameter error, SNAplus2 returns the following parameters:

primary_rc

AP_PARAMETER_CHECK

secondary_rc

Possible values are:

AP_INVALID_ALERT_NUMBER

The list_options parameter was set to AP_LIST_INCLUSIVE or AP_LIST_FROM_NEXT, but one of the following has occurred:

The alert_number parameter was not in the valid range.
The alert with the specified number has not been defined.
No alerts have been defined.

AP_INVALID_LIST_OPTION

The list_options parameter was not set to a valid value.

Appendix A “Common Return Codes” lists further secondary return codes associated with AP_PARAMETER_CHECK, which are common to all NOF verbs.

Returned Parameters: Other Conditions

Appendix A “Common Return Codes” lists further combinations of primary and secondary return codes that are common to all NOF verbs.

QUERY_3270_DIAG

Technical documentation

» Table of Contents

» Index

VCB Structure

Supplied Parameters

Returned Parameters: Successful Execution

Returned Parameters: Parameter Check

Returned Parameters: Other Conditions