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

MQe_MQe.h File Reference

Static functions. More...


Defines

#define IS_HANDLE_NULL(x)

Functions

MQERETURN mqe_abbreviate (MQeExceptBlock *pErrStruct, MQeStringHndl *phOutName, MQeStringHndl hClassName, MQEINT32 index)
 Abbreviates a Java class name or resolves an abbreviated Java class name.

MQERETURN mqe_alias (MQeExceptBlock *pErrStruct, MQeStringHndl hFrom, MQeStringHndl hTo)
 Adds/removes a class alias.

MQERETURN mqe_uniqueValue (MQeExceptBlock *pErrStruct, MQEINT64 *pUniqueValue)
 Generates a unique value.


Detailed Description

This file defines a number of static functions that are used in the system. These can be thought of as utility functions.


Define Documentation

#define IS_HANDLE_NULL  
 

Determine if the handle passed to it is representing a null object


Function Documentation

MQERETURN mqe_abbreviate MQeExceptBlock   pErrStruct,
MQeStringHndl *    phOutName,
MQeStringHndl    hClassName,
MQEINT32    index
 

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
phOutName  [out] Pointer to a pre-allocated MQeStringHndl for output.
hClassName  [in] Search name.
index  [in] Flag indicating type of operation
  • 0 = get un-abbreviated class name
  • 1 = get abbreviated class name
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
phOutName not NULL.
Returns :
(*phOutName)
 * ----------- ------------------------------
 * index       (*phOutName_)
 * ----------- ------------------------------
 * 0           un-abbreviated class name
 * 1           abbreviated class name
 * 
Return values:
MQERETURN_OK  Completed Successfully
Note:
index != 0 is interpreted as index == 1.

MQERETURN mqe_alias MQeExceptBlock   pErrStruct,
MQeStringHndl    hFrom,
MQeStringHndl    hTo
 

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
hFrom  [in] Name to be aliased
hTo  [in] Name to become
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information is returned if pErrStruct is null).
Return values:
MQERETURN_OK  Completed Successfully
Note:
If hTo is NULL, the internal alias entry is removed.

MQERETURN mqe_uniqueValue MQeExceptBlock   pErrStruct,
MQEINT64 *    pUniqueValue
 

Parameters:
pErrStruct  [in/out] Pointer to a pre-allocated MQeExceptBlock structure
pUniqueValue  [in] Pointer to result variable
Precondition:
pErrStruct points to a pre-allocated MQeExceptBlock structure (no error information. is returned if pErrStruct is null).
Precondition:
*pUniqueValue must point to an MQEINT64 variable.
Returns :
Result in (*pUniqueValue).
Return values:
MQERETURN_OK  Completed Successfully


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