MQeFieldsHide

Description
Excludes this field from the field comparison API, MQeFieldsEquals. Each field has a hide bit (initially '0') associated with it. This API allows the application to set or clear the hide bit. The hide bit is considered part of the value of a field, it is cleared if a field with the same name is put into the MQeFields object. The value of the hide bit is exported when the MQeFields object is serialized with MQeFieldsDump, so hidden fields remain hidden when MQeFields objects are transported to a different WebSphere MQ Everyplace system.

Syntax
#include <hmq.h>
MQEINT32 MQeFieldsHide( MQEHSESS hSess, MQEHFIELDS hFlds, 
            MQECHAR * pName, MQEINT32 hide, 
            MQEINT32 * pCompCode, MQEINT32 * pReason)

Parameters

MQEHSESS hSess - input
The session handle, returned by MQeInitialize.

MQEHFIELDS hFlds - input
The handle to an MQeFields object.

MQECHAR * pName - input
A null terminated string name of the field. A null or a zero length string is invalid.

MQEINT32 hide - input

'0'
Clears field element's hide bit, rendering it eligible for comparison by MQeFieldsEquals.

nonzero
Sets field element's hide bit, rendering it ineligible for comparison by MQeFieldsEquals.

MQEINT32 * pCompCode - output
MQECC_OK, MQECC_WARNING or MQECC_ERROR.

MQEINT32 * pReason - output
If the returned *pCompCode equals MQECC_ERROR, *pReason may have any of the following values:

MQE_EXCEPT_NOT_FOUND
The specified field is not present in the MQeFields object.

MQE_EXCEPT_INVALID_HANDLE

MQE_EXCEPT_INVALID_ARGUMENT

MQE_EXCEPT_ALLOCATION_FAILED

Return Value

MQEINT32
Returns '0' on success, or '-1' on failure.

Example
See example in MQeFieldsEquals.

See Also
MQeFieldsEquals.



© IBM Corporation 2002. All Rights Reserved