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

MQe_LocalKey.h File Reference


Detailed Description

MQeLocalKey Functions.


Functions

MQERETURN mqeLocalKey_new (MQeExceptBlock *pErrStruct, MQeLocalKeyHndl *phNewKey)
 This function constructs and initialises an MQeLocalKey.

MQERETURN mqeLocalKey_setKeySeed (MQeLocalKeyHndl hKey, MQeExceptBlock *pErrStruct, MQeStringHndl hKeyValue)
 Set local key seed value.


Function Documentation

MQERETURN mqeLocalKey_new MQeExceptBlock   pErrStruct,
MQeLocalKeyHndl *    phNewKey
 

This function constructs and initialises an MQeLocalKey.

Parameters:
pErrStruct  [in/out] pointer to a pre-allocated MQeExceptBlock structure.
phNewKey  [in/out] pointer to the new MQeLocalKey handle.
Precondition:
pErrStruct must not be NULL.
Returns :
(*phNewKey).
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_S_LOCALKEY_NEW_FAIL 
  • MQEREASON_LOCALKEY_ALLOC_FAIL memory allocation failure
other 
  • other common error codes caused by invalid supplied parameters
Warning:
Users are expected to use mqeKey_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.

MQERETURN mqeLocalKey_setKeySeed MQeLocalKeyHndl    hKey,
MQeExceptBlock   pErrStruct,
MQeStringHndl    hKeyValue
 

Set local key seed value.

Parameters:
hKey  [in/out] the MQeLocalKey to be set.
pErrStruct  [in/out] pointer to a pre-allocated MQeExceptBlock structure.
hKeyValue  [in] the input value.
Precondition:
pErrStruct must not be NULL/empty.
Return values:
MQERETURN_OK 
  • Operation successful
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_LOCALKEY_NULL_SEED hKeyValue is a NULL string
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_LOCALKEY_NONASCII_SEED hKeyValue is not an Ascii string
MQERETURN_INVALID_ARGUMENT 
  • MQEREASON_LOCALKEY_EMPTY_SEED hKeyValue is an empty string
MQERETURN_S_LOCALKEY_SETKEYSEED_FAIL 
  • various internal errors
MQERETURN_INTERNAL_ERROR 
  • MQEREASON_NA internal errors
other 
  • other common error codes caused by invalid supplied parameters
Warning:
hKeyValue must be a single byte string.


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