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

MQe_MARSCryptor.h File Reference

MQeMARSCryptor object. More...


Functions

MQERETURN mqeMARSCryptor_new (MQeExceptBlock *pErrStruct, MQeMARSCryptorHndl *phMARSCryptor)
 This function constructs an MQeMARSCryptor object.

MQERETURN mqeMARSCryptor_free (MQeMARSCryptorHndl hMARSCryptor, MQeExceptBlock *pErrStruct)
 frees the MQeMARSCryptor handle hMARSCryptor


Detailed Description

It describes MQe_MARSCryptor C API prototypes.


Function Documentation

MQERETURN mqeMARSCryptor_new MQeExceptBlock   pErrStruct,
MQeMARSCryptorHndl *    phMARSCryptor
 

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
phMARSCryptor  [in] Pointer to handle for output
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
phMARSCryptor must not be NULL.
Returns :
Output in (*phMARSCryptor).
Return values:
MQERETURN_OK  Completed Successfully
Warning:
Users are expected to use mqeMARSCryptor_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 mqeMARSCryptor_free MQeMARSCryptorHndl    hMARSCryptor,
MQeExceptBlock   pErrStruct
 

Parameters:
hMARSCryptor  [in] Handle for the MQeMARSCryptor 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


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