Functions | |
MQERETURN | mqeAdminMsg_free (MQeAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct) |
Frees the MQeAdminMsgHndl pointed by phMsgObj. | |
MQERETURN | mqeAdminMsg_create (MQeAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQECONST MQeFieldsHndl hParms) |
Setup an administration message to run the Create action. | |
MQERETURN | mqeAdminMsg_characteristics (MQeAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeFieldsHndl *phField) |
Returns a fields object containing the characteristics of the resource. | |
MQERETURN | mqeAdminMsg_delete (MQeAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQECONST MQeFieldsHndl hParms) |
Setup an administration message to run the MQE_ADMIN_ACTION_DELETE action. | |
MQERETURN | mqeAdminMsg_duplicate (MQeAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeAdminMsgHndl *phDup) |
Create a duplicate of this message. | |
MQERETURN | mqeAdminMsg_getAction (MQeAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 *pAction) |
Return the administration action. | |
MQERETURN | mqeAdminMsg_getErrorFields (MQeAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeFieldsHndl *phErrors) |
Return a reference to the error fields object. | |
MQERETURN | mqeAdminMsg_getFieldInError (MQeAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeStringHndl *phErrors, MQEINT32 *pNumOfErrors, MQECONST MQeStringHndl hFieldName) |
Return error(s) for a named field. | |
MQERETURN | mqeAdminMsg_getInputFields (MQeAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeFieldsHndl *phFields) |
Return a reference to the input fields parameters. | |
MQERETURN | mqeAdminMsg_getMaxAttempts (MQeAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 *pMaxAttempts) |
Gets the maximum number of retries. | |
MQERETURN | mqeAdminMsg_getName (MQeAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeStringHndl *phName) |
Return the name of the managed resource. | |
MQERETURN | mqeAdminMsg_getOutputFields (MQeAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeFieldsHndl *phFields) |
Return a reference to the output fields object. | |
MQERETURN | mqeAdminMsg_getRC (MQeAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 *pRC) |
Return the return code. | |
MQERETURN | mqeAdminMsg_getReason (MQeAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeStringHndl *phReason) |
Return the reason for failure. | |
MQERETURN | mqeAdminMsg_getTargetQMgr (MQeAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQeStringHndl *phName) |
Returns the queue manager where the result is to be processed. | |
MQERETURN | mqeAdminMsg_inquire (MQeAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQECONST MQeFieldsHndl hParms) |
Setup an administration message to run the Inquire action. | |
MQERETURN | mqeAdminMsg_inquireAll (MQeAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQECONST MQeFieldsHndl hParms) |
Setup an administration message to run the InquireAll action. | |
MQERETURN | mqeAdminMsg_setAction (MQeAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 action) |
Set the action to perform. | |
MQERETURN | mqeAdminMsg_setName (MQeAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hName) |
Set the name of the resource to be managed. | |
MQERETURN | mqeAdminMsg_setTargetQMgr (MQeAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hName) |
Set the target queue manager on which the request is to be processed. | |
MQERETURN | mqeAdminMsg_setMaxAttempts (MQeAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQEINT32 maxAttempts) |
Set the maximum attempts. | |
MQERETURN | mqeAdminMsg_update (MQeAdminMsgHndl hMsgObj, MQeExceptBlock *pErrStruct, MQECONST MQeFieldsHndl hParms) |
Setup an administration message to run the Update action. |
An MQeAdminMsg is a specialization of MQeMessage. It provides helper functions to create messages that are used for administration. Further specializations of MQeAdminMsg are available for specific uses.
Note that there are no new methods here, but there is a free. This free can be called on any administration message to release the storage.
Administration messages come in 2 styles, requests and replies:
Requests contain:
|
|
|
Sets up an administration message to run the MQE_ADMIN_ACTION_CREATE action Attempts to create a new managed resource with the characteristics specified in the hParams parameters.
|
|
Returns a fields object containing the characteristics of the resource. The complete set of field names and types for the resource can be determined from the resulting fields object.
|
|
Attempts to delete a managed resource
|
|
All MQSeries Everyplace fields are duplicated with the exception of fields that constitute the unique message ID. mqeFields_copy is employed which means that only a shallow copy of the message is made.
|
|
Returns the administration action that is to be or has been performed.
|
|
Error fields contain any errors related to problems that occurred when processing the action. For instance suppose a request is made to update two characteristics and one succeeds and one fails. Error fields contain the details of the one that fails. The name of the field in error matches that in MQE_ADMIN_PARAMS.
|
|
This method is used to obtain information on individual errors after a mqeAdminMsg_getRC return of MQE_ADMIN_RC_FAIL or MQE_ADMIN_RC_MIXED. Given a fields name return any error that occurred when processing the field. If the field that was processed was an array then a corresponding string array, containing the same number of elements, is returned . If the field that was processed was not an array, the returned array only contain one element. If the field was not in error then null is returned.
|
|
The input fields object contains the input parameters required for a specific action.
|
|
Get the maximum number of times the request should be retried if the request is not successfully transmitted at the time of the initial request.
|
|
|
|
OutputFields contains both the input parameters of a request and the results of the request.
|
|
Gets the code resulting from the action
|
|
|
|
|
|
|
|
|
|
Applicable actions are:
|
|
|
|
|
|
|
|
Sets up the administration message to perform the MQE_ADMIN_ACTION_UPDATE action. This action attempts to update the characteristics of a managed resources based on those in hParams
|