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

MQe_Compressor.h File Reference


Detailed Description

API header file for MQe Compressor.


Functions

MQERETURN mqeCompressor_new (MQeExceptBlock *pErrStruct, MQeCompressorHndl *phNewCompressor, MQeStringHndl hToken)
 creates a new compressor.

MQERETURN mqeCompressor_free (MQeCompressorHndl hCompressor, MQeExceptBlock *pErrStruct)
 polymorphic API for freeing a compressor.

MQERETURN mqeCompressor_getPrivateData (MQeCompressorHndl hCompressor, MQeExceptBlock *pErrStruct, MQEVOID **ppDataBlock)
 get the pointer to the subclass private data block.


Function Documentation

MQERETURN mqeCompressor_new MQeExceptBlock   pErrStruct,
MQeCompressorHndl *    phNewCompressor,
MQeStringHndl    hToken
 

creates a new compressor.

Parameters:
pErrStruct  [in/out] pointer to exception block.
phNewCompressor  [in/out] pointer to output handle variable.
hToken  [in] compressor 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 *phNewCompressor.
Return values:
MQERETURN_OK 
  • Completed Sucessfully
MQERETURN_S_COMPRESSOR_PLUGININIT_FAIL 
  • plugin returned return code
MQERETURN_S_COMPRESSOR_NEW_FAIL 
  • MQEREASON_COMPRESSOR_ALLOC_FAIL failed to allocate memory
MQERETURN_S_COMPRESSOR_NEW_FAIL 
  • MQEREASON_COMPRESSOR_MODULERESOLVE_FAIL failed to resolve plugin module init function
MQERETURN_S_COMPRESSOR_NEW_FAIL 
  • MQEREASON_COMPRESSOR_MODULELOAD_FAIL failed to load plugin module
MQERETURN_S_COMPRESSOR_NEW_FAIL 
  • MQEREASON_COMPRESSOR_NO_COMPRESS_FUNC compress/decompress implementation function not specified
MQERETURN_S_COMPRESSOR_NEW_FAIL 
  • other error codes due to internal errors
other 
  • other common error codes caused by invalid supplied parameters

MQERETURN mqeCompressor_free MQeCompressorHndl    hCompressor,
MQeExceptBlock   pErrStruct
 

polymorphic API for freeing a compressor.

Parameters:
hCompressor  [in] compressor 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_COMPRESSOR_PLUGINFREE_FAIL 
  • plugin returned return code
MQERETURN_S_COMPRESSOR_FREE_FAIL 
  • MQEREASON_COMPRESSOR_FREE_FAIL failed to free memory
MQERETURN_S_COMPRESSOR_FREE_FAIL 
  • other reason codes due to internal errors
other 
  • other common error codes caused by invalid supplied parameters

MQERETURN mqeCompressor_getPrivateData MQeCompressorHndl    hCompressor,
MQeExceptBlock   pErrStruct,
MQEVOID **    ppDataBlock
 

get the pointer to the subclass private data block.

Parameters:
hCompressor  [in] compressor 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