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

MQe_Key.h File Reference

MQeKey Functions. More...


Functions

MQERETURN mqeKey_new (MQeExceptBlock *pExceptBlock, MQeKeyHndl *phKey)
 Constructs an MQeKey.

MQERETURN mqeKey_free (MQeKeyHndl hKey, MQeExceptBlock *pExceptBlock)
 Frees the MQeKey pointed to by hKey.

MQERETURN mqeKey_setLocalKey (MQeKeyHndl hKey, MQeExceptBlock *pExceptBlock, MQECONST MQeStringHndl hLocalCipherKey)
 Sets the seed from which the encrypt and decrypt keys are derived.


Detailed Description

MQeKeys can be attached to and used by an attribute.


Function Documentation

MQERETURN mqeKey_new MQeExceptBlock   pExceptBlock,
MQeKeyHndl *    phKey
 

Parameters:
pExceptBlock  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
phKey  [out] Pointer to handle for output
Precondition:
pExceptBlock points to a pre-allocated MQeExceptBlock structure (no error information is returned if pExceptBlock is null).
phKey must not be NULL.
Returns :
A new MQeKey handle is created and returned via phKey
Warning:
Users are expected to use mqeKey_free() to free the key returned by this call when it is no longer needed. This enables reuse of system resources and can help to avoid system problems caused by shortage of resources.
Return values:
MQERETURN_OK 
  • Completed Successfully

MQERETURN mqeKey_free MQeKeyHndl    hKey,
MQeExceptBlock   pExceptBlock
 

Parameters:
hKey  [in] Handle for the MQeKey to be freed
pExceptBlock  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
Precondition:
pExceptBlock points to a pre-allocated MQeExceptBlock structure (no error information is returned if pExceptBlock is null).
Return values:
MQERETURN_OK 
  • Completed Successfully

MQERETURN mqeKey_setLocalKey MQeKeyHndl    hKey,
MQeExceptBlock   pExceptBlock,
MQECONST MQeStringHndl    hLocalCipherKey
 

Parameters:
hKey  [in] Handle for the MQeKey to be operated on
pExceptBlock  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hLocalCipherKey  [in] Seed from which the encrypt and decrypt keys are derived
Precondition:
pExceptBlock points to a pre-allocated MQeExceptBlock structure (no error information is returned if pExceptBlock is null).
Return values:
MQERETURN_OK 
  • Completed Successfully
MQERETURN_J_NOT_ALLOWED 
  • Action not allowed. No reason code


Generated Thu Aug 11 23:41:19 2005 for Websphere MQ Everyplace for Multiplatforms C Bindings Reference