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

MQe_RleCompressor.h File Reference

MQeRleCompressor object. More...


Functions

MQERETURN mqeRleCompressor_new (MQeExceptBlock *pErrStruct, MQeRleCompressorHndl *phRleCompressor)
 This function constructs an MQeRleCompressor object.

MQERETURN mqeRleCompressor_free (MQeRleCompressorHndl hRleCompressor, MQeExceptBlock *pErrStruct)
 frees the MQeRleCompressor handle hRleCompressor


Detailed Description

It describes MQe_RleCompressor C API prototypes. When use by an attribute object provides the attribute object with the mechanisms to perform RLE compression.


Function Documentation

MQERETURN mqeRleCompressor_new MQeExceptBlock   pErrStruct,
MQeRleCompressorHndl *    phRleCompressor
 

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

Parameters:
hRleCompressor  [in] handle for the MQeRleCompressor 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:23 2005 for Websphere MQ Everyplace for Multiplatforms C Bindings Reference