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

MQe_Cryptor.h File Reference


Detailed Description

API header file for MQe Cryptor.


Functions

MQERETURN mqeCryptor_new (MQeExceptBlock *pErrStruct, MQeCryptorHndl *phNewCryptor, MQeStringHndl hToken)
 creates a new cryptor.

MQERETURN mqeCryptor_free (MQeCryptorHndl hCryptor, MQeExceptBlock *pErrStruct)
 polymorphic API for freeing a cryptor.

MQERETURN mqeCryptor_getPrivateData (MQeCryptorHndl hCryptor, MQeExceptBlock *pErrStruct, MQEVOID **ppDataBlock)
 get the pointer to the subclass private data block.


Function Documentation

MQERETURN mqeCryptor_new MQeExceptBlock   pErrStruct,
MQeCryptorHndl *    phNewCryptor,
MQeStringHndl    hToken
 

creates a new cryptor.

Parameters:
pErrStruct  [in/out] pointer to exception block.
phNewCryptor  [in/out] pointer to output handle variable.
hToken  [in] cryptor class alias
Precondition:
pErrStruct should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pErrStruct is NULL).
Returns :
output in *phNewCryptor.
Return values:
MQERETURN_OK 
  • Completed Sucessfully
MQERETURN_S_CRYPTOR_PLUGININIT_FAIL 
  • plugin returned return code
MQERETURN_S_CRYPTOR_NEW_FAIL 
  • MQEREASON_CRYPTOR_ALLOC_FAIL failed to allocate memory
MQERETURN_S_CRYPTOR_NEW_FAIL 
  • MQEREASON_CRYPTOR_MODULERESOLVE_FAIL failed to resolve plugin module init function
MQERETURN_S_CRYPTOR_NEW_FAIL 
  • MQEREASON_CRYPTOR_MODULELOAD_FAIL failed to load plugin module
MQERETURN_S_CRYPTOR_NEW_FAIL 
  • MQEREASON_CRYPTOR_NO_CRYPT_FUNC encrypt/decrypt implementation funtion not specified
MQERETURN_S_CRYPTOR_NEW_FAIL 
  • other error codes due to internal errors
other 
  • other common error codes caused by invalid supplied parameters

MQERETURN mqeCryptor_free MQeCryptorHndl    hCryptor,
MQeExceptBlock   pErrStruct
 

polymorphic API for freeing a cryptor.

Parameters:
hCryptor  [in] cryptor to be freed.
pErrStruct  [in/out] pointer to exception block.
Precondition:
pErrStruct should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pErrStruct is NULL).
Return values:
MQERETURN_OK 
  • Completed Sucessfully
MQERETURN_S_CRYPTOR_PLUGINFREE_FAIL 
  • plugin returned return code
MQERETURN_S_CRYPTOR_FREE_FAIL 
  • MQEREASON_CRYPTOR_FREE_FAIL failed to free memory
MQERETURN_S_CRYPTOR_FREE_FAIL 
  • other reason codes due to internal errors
other 
  • other common error codes caused by invalid supplied parameters

MQERETURN mqeCryptor_getPrivateData MQeCryptorHndl    hCryptor,
MQeExceptBlock   pErrStruct,
MQEVOID **    ppDataBlock
 

get the pointer to the subclass private data block.

Parameters:
hCryptor  [in] cryptor to be operated on.
pErrStruct  [in/out] pointer to exception block.
ppDataBlock  [in/out] pointer to output pointer to the data block.
Precondition:
pErrStruct should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pErrStruct is NULL).
Return values:
MQERETURN_OK 
  • Completed Sucessfully
other 
  • other common error codes caused by invalid supplied parameters


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