Main Page   Modules   Data Structures   File List   Data Fields   Globals   Related Pages  

MQe_MsgAttr.h File Reference


Detailed Description

The MQeMsgAttr abstract class API header file.

MQeMsgAttr is the counterpart of MQeMAttribute in the Java code base.

When an MQeMsgAttr attribute is used for receiving messages (get/browse), if its compressor/cryptor handle is set, the type of the compressor/cryptor will be checked to see if it is appropriate. If not, the call will fail. If its compressor/cryptor handle is NULL, an appropriate temporary compressor/cryptor will be created for decoding the messages.


Functions

MQERETURN mqeMsgAttr_new (MQeExceptBlock *pErrStruct, MQeMsgAttrHndl *phNewAttribute, MQeStringHndl hCryptor, MQeStringHndl hCompressor, MQeStringHndl hKeySeed)
 Create an MQeMsgAttr handle.


Function Documentation

MQERETURN mqeMsgAttr_new MQeExceptBlock   pErrStruct,
MQeMsgAttrHndl *    phNewAttribute,
MQeStringHndl    hCryptor,
MQeStringHndl    hCompressor,
MQeStringHndl    hKeySeed
 

Create an MQeMsgAttr handle.

Parameters:
pErrStruct  [in/out] pointer to a pre-allocated MQeExceptBlock structure.
phNewAttribute  [in/out] pointer to the new MQeMsgAttr handle.
hCryptor  [in] name of cryptor to be attached to the attribute (NULL indicates no cryptor).
hCompressor  [in] name of compressor to be attached to the attribute (NULL indicates no compressor).
hKeySeed  [in] seed for the MQeKey to be generated. If NULL, no MQeKey will be generated.
Returns :
*phNewAttribute.
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_S_MSGATTR_NEW_FAIL 
  • MQEREASON_MSGATTR_ALLOC_FAIL unable to allocate enough memory
other 
  • common error codes caused by invalid supplied parameters
Warning:
Users are expected to use mqeAttrBase_free() to free the structure returned by this call after it is no longer needed. This will enable reuse of some system resources and avoid some avoidable system crashes.


Generated Thu Aug 11 23:27:10 2005 for Websphere MQ Everyplace for Multiplatforms C Programming Reference