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

MQe_MAttribute.h File Reference

The MQeMAttribute class C API header file for Java bindings. More...


Functions

MQERETURN mqeMAttribute_new (MQeExceptBlock *pErrStruct, MQeMAttributeHndl *phMAttribute, MQeAuthenticatorHndl hAuthenticator, MQeCryptorHndl hCryptor, MQeCompressorHndl hCompressor)
 This function constructs an MQeMAttribute object.

MQERETURN mqeMAttribute_free (MQeMAttributeHndl hMAttribute, MQeExceptBlock *pErrStruct)
 frees the MQeMAttribute handle hMAttribute

MQERETURN mqeMAttribute_decodeData (MQeMAttributeHndl hMAttribute, MQeExceptBlock *pErrStruct, MQEBYTE *pBuffer, MQEINT32 *pBufLength, MQEBYTE *pData, MQEINT32 offset, MQEINT32 length)
 This function decrypts and/or decompresses the bytes referenced by pData, offset and for length length.

MQERETURN mqeMAttribute_encodeData (MQeMAttributeHndl hMAttribute, MQeExceptBlock *pErrStruct, MQEBYTE *pBuffer, MQEINT32 *pBufLength, MQEBYTE *pData, MQEINT32 offset, MQEINT32 length)
 This function encrypts and/or compresses the bytes referenced by pData, offset and for length length.

MQERETURN mqeMAttribute_setKey (MQeMAttributeHndl hMAttribute, MQeExceptBlock *pErrStruct, MQeKeyHndl hKey)
 This method associates a key with the attribute. This is required if the attribute has a cryptor.


Detailed Description

This page describes MQe_MAttribute C API prototypes.


Function Documentation

MQERETURN mqeMAttribute_new MQeExceptBlock   pErrStruct,
MQeMAttributeHndl *    phMAttribute,
MQeAuthenticatorHndl    hAuthenticator,
MQeCryptorHndl    hCryptor,
MQeCompressorHndl    hCompressor
 

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
phMAttribute  [out] Pointer to handle for output
hAuthenticator  [in] Handle for an MQeAuthenticator object (or null) used to authenticate data access
hCryptor  [in] Handle for an MQeCryptor object (or null) used to encrypt and decrypt data
hCompressor  [in] Handle for an MQeCompressor object used to compress the data prior to encryption, or decompress after decryption
Precondition:
phMAttribute must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Returns :
(*phMAttribute).
Return values:
MQERETURN_OK  Operation successful
Warning:
Users are expected to use mqeMAttribute_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 mqeMAttribute_free MQeMAttributeHndl    hMAttribute,
MQeExceptBlock   pErrStruct
 

Parameters:
hMAttribute  [in] Handle for the MQeMAttribute 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  Operation successful

MQERETURN mqeMAttribute_decodeData MQeMAttributeHndl    hMAttribute,
MQeExceptBlock   pErrStruct,
MQEBYTE *    pBuffer,
MQEINT32 *    pBufLength,
MQEBYTE *    pData,
MQEINT32    offset,
MQEINT32    length
 

Parameters:
hMAttribute  [in] Handle for the MQeMAttribute to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pBuffer  [in/out] Pointer to output buffer
pBufLength  [in/out] Pointer to buffer ((*pBuffer) ) length variable
pData  [in] Pointer to a byte array to be decypted and/or decompressed
offset  [in] Offset into the data array to start
length  [in] Number of bytes in the data array to be decoded
Precondition:
hMAttribute must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Returns :
pBuffer and pBufLength:
 * ---------------------- ---------------- -------------------------------- -------------------------
 * initial (*pBufLength)  initial pBuffer  returned (*pBufLength)           returned pBuffer
 * ---------------------- ---------------- -------------------------------- -------------------------
 * 0                      any              buffer size (in bytes) required  not defined
 * any                    NULL             ditto                            ditto
 * != 0                   != NULL          buffer space used (in bytes)     points to the result
 * 
Return values:
MQERETURN_OK  Operation successful

MQERETURN mqeMAttribute_encodeData MQeMAttributeHndl    hMAttribute,
MQeExceptBlock   pErrStruct,
MQEBYTE *    pBuffer,
MQEINT32 *    pBufLength,
MQEBYTE *    pData,
MQEINT32    offset,
MQEINT32    length
 

Parameters:
hMAttribute  [in] Handle for the MQeMAttribute to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pBuffer  [in/out] Pointer to output buffer
pBufLength  [in/out] Pointer to buffer ((*pBuffer) ) length variable
pData  [in] Pointer to a byte array to be encrypted and/or compressed
offset  [in] Offset into the data array to start
length  [in] Number of bytes in the data array to be encoded
Precondition:
hMAttribute must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Returns :
pBuffer and pBufLength:
 * ---------------------- ---------------- -------------------------------- -------------------------
 * initial (*pBufLength)  initial pBuffer  returned (*pBufLength)           returned pBuffer
 * ---------------------- ---------------- -------------------------------- -------------------------
 * 0                      any              buffer size (in bytes) required  not defined
 * any                    NULL             ditto                            ditto
 * != 0                   != NULL          buffer space used (in bytes)     points to the result
 * 
Return values:
MQERETURN_OK  Operation successful

MQERETURN mqeMAttribute_setKey MQeMAttributeHndl    hMAttribute,
MQeExceptBlock   pErrStruct,
MQeKeyHndl    hKey
 

Parameters:
hMAttribute  [in] Handle for the MQeMAttribute to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hKey  [in] Handle for the MQeKey object
Precondition:
hMAttribute must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK  Operation successful


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