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

MQe_XorCryptor.h File Reference

MQeXorCryptor object. More...


Functions

MQERETURN mqeXorCryptor_new (MQeExceptBlock *pErrStruct, MQeXorCryptorHndl *phXorCryptor)
 This function constructs an MQeXorCryptor object.

MQERETURN mqeXorCryptor_free (MQeXorCryptorHndl hXorCryptor, MQeExceptBlock *pErrStruct)
 frees the MQeXorCryptor handle hXorCryptor

MQERETURN mqeXorCryptor_setDecryptKey (MQeXorCryptorHndl hXorCryptor, MQeExceptBlock *pErrStruct, MQEBYTE *pData, MQEINT32 size)
 Sets the decrypt key for this cryptor.

MQERETURN mqeXorCryptor_setEncryptKey (MQeXorCryptorHndl hXorCryptor, MQeExceptBlock *pErrStruct, MQEBYTE *pData, MQEINT32 size)
 This function sets the encrypt key for this cryptor.


Detailed Description

It describes MQe_XorCryptor C API prototypes. When used by an attribute object provides the mechanism to perform XOR encoding.


Function Documentation

MQERETURN mqeXorCryptor_new MQeExceptBlock   pErrStruct,
MQeXorCryptorHndl *    phXorCryptor
 

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
phXorCryptor  [out] Pointer to handle for output
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
phXorCryptor must not be NULL.
Returns :
output in (*phXorCryptor). \retavl MQERETURN_OK Completed Successfully
Warning:
Users are expected to use mqeXorCryptor_free() to free the object 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.

MQERETURN mqeXorCryptor_free MQeXorCryptorHndl    hXorCryptor,
MQeExceptBlock   pErrStruct
 

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

MQERETURN mqeXorCryptor_setDecryptKey MQeXorCryptorHndl    hXorCryptor,
MQeExceptBlock   pErrStruct,
MQEBYTE *    pData,
MQEINT32    size
 

The key is passed in as an array of byte data, plus a size

Parameters:
hXorCryptor  [in] Handle for the MQeXorCryptor to be operated on.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
pData  [in] Pointer to a data array containing the decrypt key.
size  [in] size of data (in bytes) in (*pData).
Precondition:
hXorCryptor must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK  Completed Successfully

MQERETURN mqeXorCryptor_setEncryptKey MQeXorCryptorHndl    hXorCryptor,
MQeExceptBlock   pErrStruct,
MQEBYTE *    pData,
MQEINT32    size
 

The key is passed in as an array of byte data, plus a size

Parameters:
hXorCryptor  [in] Handle for the MQeXorCryptor to be operated on.
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure.
pData  [in] Pointer to a data array containing the encrypt key.
size  [in] size of data (in bytes) in (*pData).
Precondition:
hXorCryptor must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK  Completed Successfully


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