QUERY_NMVT_APPLICATION

QUERY_NMVT_APPLICATION returns a list of applications that have registered for network management vector transport (NMVT) level messages by previously issuing the REGISTER_NMVT_APPLICATION verb (see Management Services Verbs for more details).

The information is returned as a list. To obtain information about a specific application, or to obtain the list information in several chunks, the application field should be set.

Otherwise (if the list_options field is set to AP_FIRST_IN_LIST), this field will be ignored. See Querying the Node for background on how the list formats are used.

VCB Structure

typedef struct query_nmvt_application
{
        unsigned short  opcode;             /* verb operation code           */
        unsigned char   reserv2;            /* reserved                      */
        unsigned char   format;             /* format                        */
        unsigned short  primary_rc;         /* primary return code           */
        unsigned long   secondary_rc;       /* secondary return code         */
        unsigned char   *buf_ptr;           /* pointer to buffer             */
        unsigned long   buf_size;           /* buffer size                   */
        unsigned long   total_buf_size;     /* total buffer size required    */
        unsigned short  num_entries;        /* number of entries             */
        unsigned short  total_num_entries;  /* total number of entries       */
        unsigned char   list_options;       /* listing options               */
        unsigned char   reserv3;            /* reserved                      */
        unsigned char   application[8];     /* application                   */
} QUERY_NMVT_APPLICATION;
typedef struct nmvt_application_data
{
        unsigned short  overlay_size;       /* size of this entry            */
        unsigned char   application[8];     /* application name              */
        unsigned short  ms_vector_key_type; /* MS vector key accepted        */
                                            /* by appl                       */
        unsigned char   conversion_required;
                                            /* conversion to MDS_MU required */
        unsigned char   reserv[5];          /* reserved                      */
        unsigned char   reserva[20];        /* reserved                      */
} NMVT_APPLICATION_DATA;

Supplied Parameters

The application supplies the following parameters:
opcode
AP_QUERY_NMVT_APPLICATION
format
Identifies the format of the VCB. Set this field to zero to specify the version of the VCB listed above.
buf_ptr
Pointer to a buffer into which list information can be written. The application can append data to the end of the VCB, in which case buf_ptr must be set to NULL.
buf_size
Size of buffer supplied. The data returned will not exceed this size.
num_entries
Maximum number of entries to return. The number of entries will not exceed this value. A value of zero means no limit.
list_options
This indicates what should be returned in the list information: The application specified (see the following parameter, application) represents an index value that is used to specify the starting point of the actual information to be returned.
AP_FIRST_IN_LIST
The index value is ignored, and the returned list starts from the first entry in the list.
AP_LIST_FROM_NEXT
The returned list starts from the next entry in the list after the one specified by the supplied index value.
AP_LIST_INCLUSIVE
The returned list starts from the entry specified by the index value.
application
Application name. The name is an 8-byte alphanumeric type-A EBCDIC character string or all EBCDIC zeros. This field is ignored if list_options is set to AP_FIRST_IN_LIST.

Returned Parameters

If the verb executes successfully, the Program 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 can be higher than buf_size.
num_entries
The number of entries actually returned.
total_num_entries
Total number of entries that could have been returned. This can be higher than num_entries.
nmvt_application_data.overlay_size
The number of bytes in this entry, and hence the offset to the next entry returned (if any).
nmvt_application_data.application
Name of registered application. The name is an 8-byte alphanumeric type-A EBCDIC character string.
nmvt_application_data.ms_vector_key_type
Management services vector key accepted by the application. When the application registers for NMVT messages, it specifies which management services vector keys it will accept. For more information on NMVT application registration see Management Services Verbs.
nmvt_application_data.conversion_required
Specifies whether the registered application requires messages to be converted from NMVT to MDS_MU format (AP_YES or AP_NO). When the application registers for NMVT messages, it will specify whether this conversion is required. For more information on NMVT application registration, see Management Services Verbs.
If the verb does not execute because of a parameter error, the Program returns the following parameters:
primary_rc
AP_PARAMETER_CHECK
secondary_rc
AP_INVALID_APPLICATION_NAME

AP_INVALID_LIST_OPTION

If the verb does not execute because the node has not yet been started, the Program returns the following parameter:
primary_rc
AP_NODE_NOT_STARTED
If the verb does not execute because of a system error, the Program returns the following parameter:
primary_rc
AP_UNEXPECTED_SYSTEM_ERROR