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

MQe_Attribute.h File Reference

MQeAttribute. More...


Functions

MQERETURN mqeAttribute_new (MQeExceptBlock *pErrStruct, MQeAttributeHndl *phAttribute, MQECONST MQeStringHndl hRuleClassName, MQeAuthenticatorHndl hAuthenticator, MQeCryptorHndl hCryptor, MQeCompressorHndl hCompressor)
 This function returns an MQeAttribute handle.

MQERETURN mqeAttribute_free (MQeAttributeHndl hAttribute, MQeExceptBlock *pErrStruct)
 Frees the MQeAttribute handle hAttribute.

MQERETURN mqeAttribute_activate (MQeAttributeHndl hAttribute, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hRuleClassName, MQeAuthenticatorHndl hAuthenticator, MQeCryptorHndl hCryptor, MQeCompressorHndl hCompressor)
 This function activates an MQeAttribute handle.

MQERETURN mqeAttribute_authenticatedID (MQeAttributeHndl hAttribute, MQeExceptBlock *pErrStruct, MQeStringHndl *phID)
 This function returns the authenticated ID.

MQERETURN mqeAttribute_change (MQeAttributeHndl hAttribute, MQeExceptBlock *pErrStruct, MQECONST MQeStringHndl hRuleClassName, MQeAttributeHndl hNewAttribute)
 This function changes the current Attribute.

MQERETURN mqeAttribute_close (MQeAttributeHndl hAttribute, MQeExceptBlock *pErrStruct)
 This function closes the attribute.

MQERETURN mqeAttribute_decodeData (MQeAttributeHndl hAttribute, MQeExceptBlock *pErrStruct, MQEBYTE *pBuffer, MQEINT32 *pBufLength, MQEBYTE *pData, MQEINT32 offset, MQEINT32 length)
 This function decrypts and/or decompresses the bytes referenced by pData, at offset offset and for length length.

MQERETURN mqeAttribute_encodeData (MQeAttributeHndl hAttribute, MQeExceptBlock *pErrStruct, MQEBYTE *pBuffer, MQEINT32 *pBufLength, MQEBYTE *pData, MQEINT32 offset, MQEINT32 length)
 This function encrypts and/or compresses the bytes referenced by pData, at offset offset and for length length.

MQERETURN mqeAttribute_isAcceptable (MQeAttributeHndl hAttribute, MQeExceptBlock *pErrStruct, MQEBOOL *pIsAcceptable, MQeAttributeHndl hAlternative)
 Check if hAlternative is an acceptable attribute for replacing hAttribute.

MQERETURN mqeAttribute_getAuthenticator (MQeAttributeHndl hAttribute, MQeExceptBlock *pErrStruct, MQeAuthenticatorHndl *phOut)
 This function gets the authenticator attached to this attribute.

MQERETURN mqeAttribute_getCompressor (MQeAttributeHndl hAttribute, MQeExceptBlock *pErrStruct, MQeCompressorHndl *phOut)
 This function gets the compressor attached to this attribute.

MQERETURN mqeAttribute_getCryptor (MQeAttributeHndl hAttribute, MQeExceptBlock *pErrStruct, MQeCryptorHndl *phOut)
 This function gets the cryptor attached to this attribute.

MQERETURN mqeAttribute_setKey (MQeAttributeHndl hAttribute, MQeExceptBlock *pErrStruct, MQeKeyHndl hKey)
 This method associates a key with the attribute. This key is required if the attribute has a cryptor.


Detailed Description

Describes MQeAttribute API prototypes.


Function Documentation

MQERETURN mqeAttribute_new MQeExceptBlock   pErrStruct,
MQeAttributeHndl *    phAttribute,
MQECONST MQeStringHndl    hRuleClassName,
MQeAuthenticatorHndl    hAuthenticator,
MQeCryptorHndl    hCryptor,
MQeCompressorHndl    hCompressor
 

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
phAttribute  [out] Pointer to handle for output.
hRuleClassName  [in] Rule class name (or null) used to verify that various operations are permitted
hAuthenticator  [in] Handle for an MQeAuthenticator (or null) used to authenticate data access
hCryptor  [in] Handle for an MQeCryptor (or null) used to encrypt and decrypt data
hCompressor  [in] Handle for an MQeCompressor used to compress the data prior to encryption or decompress after decryption.
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
phAttribute must not be NULL.
Returns :
New MQeAttribute handle is placed in (*phAttribute)
Return values:
MQERETURN_OK  Completed Successfully
Warning:
Users are expected to use mqeAttribute_free() to free the handle 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.
Note:
Function mqeAttribute_activate() is called undercover using the parameters provided.

MQERETURN mqeAttribute_free MQeAttributeHndl    hAttribute,
MQeExceptBlock   pErrStruct
 

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

MQERETURN mqeAttribute_activate MQeAttributeHndl    hAttribute,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hRuleClassName,
MQeAuthenticatorHndl    hAuthenticator,
MQeCryptorHndl    hCryptor,
MQeCompressorHndl    hCompressor
 

Typically used when not in a networked environment.

Parameters:
hAttribute  [in] Handle for the MQeAttribute to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hRuleClassName  [in] Rule class name (or null) used to verify that various operations are permitted
hAuthenticator  [in] Handle for an MQeAuthenticator (or null) used to authenticate data access
hCryptor  [in] Handle for an MQeCryptor (or null) used to encrypt and decrypt data
hCompressor  [in] Handle for an MQeCompressor used to compress the data prior to encryption or decompress after decryption
Precondition:
hAttribute 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  Completed Successfully

MQERETURN mqeAttribute_authenticatedID MQeAttributeHndl    hAttribute,
MQeExceptBlock   pErrStruct,
MQeStringHndl *    phID
 

(*phID) is NULL if not authenticated.

Parameters:
hAttribute  [in] Handle for the MQeAttribute to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
phID  [out] Handle to a resultant MQeString
Precondition:
hAttribute must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Returns :
MQeStringHndl for the ID in (*phID)
Return values:
MQERETURN_OK  Completed Successfully
Warning:
Users are expected to use mqeString_free() to free the handle 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 mqeAttribute_change MQeAttributeHndl    hAttribute,
MQeExceptBlock   pErrStruct,
MQECONST MQeStringHndl    hRuleClassName,
MQeAttributeHndl    hNewAttribute
 

Parameters:
hAttribute  [in] Handle for the MQeAttribute to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hRuleClassName  [in] The name (or null) of a rule class used to verify that certain operations are permitted (the previous rules must allow the new rules)
hNewAttribute  [in] Handle for new attributes
Precondition:
hAttribute 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  Completed Successfully

MQERETURN mqeAttribute_close MQeAttributeHndl    hAttribute,
MQeExceptBlock   pErrStruct
 

Parameters:
hAttribute  [in] Handle for the MQeAttribute to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
Precondition:
hAttribute 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  Completed Successfully

MQERETURN mqeAttribute_decodeData MQeAttributeHndl    hAttribute,
MQeExceptBlock   pErrStruct,
MQEBYTE *    pBuffer,
MQEINT32 *    pBufLength,
MQEBYTE *    pData,
MQEINT32    offset,
MQEINT32    length
 

Parameters:
hAttribute  [in] Handle for the MQeAttribute 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 decrypted and/or decompressed
offset  [in] Offset into the data array at which to start
length  [in] Number of bytes in the data array to be decoded
Precondition:
hAttribute 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  Completed Successfully

MQERETURN mqeAttribute_encodeData MQeAttributeHndl    hAttribute,
MQeExceptBlock   pErrStruct,
MQEBYTE *    pBuffer,
MQEINT32 *    pBufLength,
MQEBYTE *    pData,
MQEINT32    offset,
MQEINT32    length
 

Parameters:
hAttribute  [in] Handle for the MQeAttribute to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pBuffer  [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:
hAttribute 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  Completed Successfully

MQERETURN mqeAttribute_isAcceptable MQeAttributeHndl    hAttribute,
MQeExceptBlock   pErrStruct,
MQEBOOL *    pIsAcceptable,
MQeAttributeHndl    hAlternative
 

This function normally compares hAttribute and hAlternative using the rule attached to the attribute hAttribute. If no rule is attached, this function returns MQE_TRUE in (*pIsAcceptable) if hAttribute's and hAlternative's authenticator, compressor, and cryptor are the same. Otherwise, it returns MQE_FALSE.

Parameters:
hAttribute  [in] Handle to the MQeAttribute to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pIsAcceptable  [out] Pointer to the result variable
hAlternative  [in] Handle to the alternative attribute
Precondition:
hAttribute must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
pIsAcceptable points to the result variable.
Returns :
result in (*pIsAcceptable).
Return values:
MQERETURN_OK  Completed Successfully

MQERETURN mqeAttribute_getAuthenticator MQeAttributeHndl    hAttribute,
MQeExceptBlock   pErrStruct,
MQeAuthenticatorHndl *    phOut
 

Parameters:
hAttribute  [in] Handle for the MQeAttribute to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
phOut  [out] Pointer to the output handle
Precondition:
hAttribute must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
phOut must point to an existing handle.
Returns :
result in (*phOut).
Return values:
MQERETURN_OK  Completed Successfully

MQERETURN mqeAttribute_getCompressor MQeAttributeHndl    hAttribute,
MQeExceptBlock   pErrStruct,
MQeCompressorHndl *    phOut
 

Parameters:
hAttribute  [in] Handle for the MQeAttribute to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
phOut  [out] Pointer to the output handle
Precondition:
hAttribute must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
phOut must point to an existing handle.
Returns :
result in (*phOut).
Return values:
MQERETURN_OK  Completed Successfully

MQERETURN mqeAttribute_getCryptor MQeAttributeHndl    hAttribute,
MQeExceptBlock   pErrStruct,
MQeCryptorHndl *    phOut
 

Parameters:
hAttribute  [in] Handle for the MQeAttribute to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
phOut  [out] Pointer to the output handle
Precondition:
hAttribute must not be NULL.
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
phOut must point to an existing handle.
Returns :
result in (*phOut).
Return values:
MQERETURN_OK  Completed Successfully

MQERETURN mqeAttribute_setKey MQeAttributeHndl    hAttribute,
MQeExceptBlock   pErrStruct,
MQeKeyHndl    hKey
 

Parameters:
hAttribute  [in] Handle for the MQeAttribute to be operated on
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hKey  [in] Handle for the MQeKey
Precondition:
hAttribute 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  Completed Successfully


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