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

MQe_FieldsAttr.h File Reference


Detailed Description

The MQeFieldsAttr API header file for native code base.

This page describes MQe_FieldsAttr API prototypes. MQeFieldsAttr is a type of attribute which can be attached to an MQeFields item. See documentation on MQe_AttrBase.h for more detail


Functions

MQERETURN mqeFieldsAttr_activate (MQeFieldsAttrHndl hAttribute, MQeExceptBlock *pErrStruct)
 MQeFieldsAttr implementation of activation method.

MQERETURN mqeFieldsAttr_new (MQeExceptBlock *pErrStruct, MQeFieldsAttrHndl *phNewAttribute, MQeStringHndl hAuthenticator, MQeStringHndl hCryptor, MQeStringHndl hCompressor, MQeStringHndl hKeySeed)
 Create an MQeFieldsAttr structure.


Function Documentation

MQERETURN mqeFieldsAttr_activate MQeFieldsAttrHndl    hAttribute,
MQeExceptBlock   pErrStruct
 

MQeFieldsAttr implementation of activation method.

Parameters:
hAttribute  [in] handle for the MQeFieldsAttr to be activated.
pErrStruct  [in/out] pointer to a pre-allocated MQeExceptBlock structure.
Precondition:
pErrStruct must not be NULL.
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_S_FIELDSATTR_AUTHENTICATE_FAIL 
  • MQEREASON_FIELDSATTR_ACTIVATELOCAL_FAIL failed to perform a local authentication
other 
  • other common error codes caused by invalid supplied parameters

MQERETURN mqeFieldsAttr_new MQeExceptBlock   pErrStruct,
MQeFieldsAttrHndl *    phNewAttribute,
MQeStringHndl    hAuthenticator,
MQeStringHndl    hCryptor,
MQeStringHndl    hCompressor,
MQeStringHndl    hKeySeed
 

Create an MQeFieldsAttr structure.

Parameters:
pErrStruct  [in/out] pointer to a pre-allocated MQeExceptBlock structure.
phNewAttribute  [in/out] pointer to the new MQeFieldsAttr handle.
hAuthenticator  [in] name of authenticator to be attached to the attribute (NULL indicates no authenticator).
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_FIELDSATTR_NEW_FAIL 
  • MQEREASON_FIELDSATTR_ALLOC_FAIL unable to allocate enough memory
other 
  • 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 Wed Jun 9 00:27:18 2004 for Websphere MQ Everyplace for Multiplatforms C Programming Reference