MIBSendRequest—MIB queue request function

Purpose

Use this function when an application program needs to send VTAM-specific requests. For a list of these requests, see VTAM-specific requests and responses.

Declarations

The following declarations indicate the order of the parameters for this function.

typedef int MIBSendRequest_t(
               int,                 /* link identifier - input       */
               unsigned int *,      /* returned invoke identifier -
                                        output                       */
               const void *,        /* local identifier - input      */
               const char *);       /* message - input               */

Parameters

link identifier: Specifies the link identifier returned by the MIBConnect function.
returned invoke identifier: Specifies the invoke identifier. The invoke identifier is used to correlate this request with a response that arrives subsequently.
local identifier: Pointer to the local identifier of the object that is issuing the request.
message: This is a pointer to a formatted string which contains the string header and the request data.

Return codes

0

The function was successful.

MB_ERR_ALLOC

An error occurred allocating storage. If MB_ERR_ALLOC is received by the application program from an API function and there is a corresponding REQS record in the VIT with a nonzero return code, the LPBUF pool is not large enough and should be increased.

MB_ERR_CMIP_SERVICES_INACTIVE

CMIP services is inactive.

If using common storage area storage, the read queue exit routine stops functioning.

If using data space storage, messages are not put on the data space.

MB_WARN_DATA_SPACE_FULL

If using a data space and the data space is out of storage, this warning is returned to remind the application program that no messages will be returned to this application program. This message will still be routed to CMIP services.

MB_WARN_EXIT_FAILURE

If using common storage area storage and the application program has indicated that it has had an unrecoverable error when returning to the read queue exit routine, this warning is returned to remind the application program that no messages will be returned to the application program. This message will still be routed to CMIP services.

MB_ERR_INVALID_INVOKE_ID

The invoke identifier parameter was not provided.

MB_ERR_LOCAL_ID_MISSING

A local identifier was not provided.

MB_ERR_INVALID_MAX_INVOKE_IDS

The value specified for the maximum outstanding requests parameter is not valid.

MB_ERR_MSG_MISSING

The message parameter was not provided.

MB_ERR_TRANSMIT

An apparent error occurred. Either there is a logic error in VTAM®, or the MIBDisconnect function has been issued, but it has not completed.

MB_ERR_VTAM_INACTIVE

VTAM is inactive.

Example of function in an application program

The following example shows how the MIBSendRequest function can be coded in an application program.

int LinkId;
unsigned int InvokeId;
MIBSendRequest_t *MIBSendRequest;
 
/***********************************************************/
/* Retrieve information on the association with handle a1. */
/***********************************************************/
 
rc = MIBSendRequest(LinkId,
                    &InvokeId,
                    &MyLocalId,
                    "msg ACF.GetAssociationInfo("
                    "handle 'a1', info 11111111)");