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

MQe_GZIPCompressor.h File Reference

MQeGZIPCompressor object. More...


Functions

MQERETURN mqeGZIPCompressor_new (MQeExceptBlock *pErrStruct, MQeGZIPCompressorHndl *phGZIPCompressor)
 This function constructs an MQeGZIPCompressor object.

MQERETURN mqeGZIPCompressor_free (MQeGZIPCompressorHndl hGZIPCompressor, MQeExceptBlock *pErrStruct)
 frees the MQeGZIPCompressor handle hGZIPCompressor


Detailed Description

This page describes MQe_GZIPCompressor C API prototypes.


Function Documentation

MQERETURN mqeGZIPCompressor_new MQeExceptBlock   pErrStruct,
MQeGZIPCompressorHndl *    phGZIPCompressor
 

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

Parameters:
hGZIPCompressor  [in/out] Handle for the MQeGZIPCompressor to be freed
pErrStruct  [in] 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