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

MQe_ClassAlias.h File Reference


Detailed Description

API header file for MQe Class Alias.


Functions

MQERETURN mqeClassAlias_delete (MQeExceptBlock *pExceptBlk, MQeStringHndl hKey)
MQERETURN mqeClassAlias_add (MQeExceptBlock *pExceptBlk, MQeStringHndl hKey, MQeStringHndl hModule, MQeStringHndl hEntry)


Function Documentation

MQERETURN mqeClassAlias_delete MQeExceptBlock   pExceptBlk,
MQeStringHndl    hKey
 

Delete a key entry from the system table. Resources attached to the key are freed. The table is locked while being updated.

Parameters:
pExceptBlk  [in/out] Exception block to be filled in case of error
hKey  [in] handle to key string
Return values:
MQERETURN_OK 
  • success.
MQERETURN_CLASSALIAS_DELETE_FAIL 
  • MQEREASON_NA Attempt has been made to release all attached resources but something went wrong
MQERETURN_CLASSALIAS_DELETE_FAIL 
  • MQEREASON_CLASSALIAS_NOT_MODIFIABLE The entry has been defined by the system
MQERETURN_CLASSALIAS_LOCK_FAIL 
  • MQEREASON_NA Could not lock the mapping tables
other 
  • other common error codes caused by invalid supplied parameters

MQERETURN mqeClassAlias_add MQeExceptBlock   pExceptBlk,
MQeStringHndl    hKey,
MQeStringHndl    hModule,
MQeStringHndl    hEntry
 

Add a new/update an existing entry to the internal table. The MQeStrings hKey, hModule, and hEntry are added to the table. The table is locked while being updated. The original value strings are freed if an entry is updated.

Parameters:
pExceptBlk  [in/out] Exception block to be filled in case of error
hKey  [in] handle to key string
hModule  [in] handle to module name
hEntry  [in] handle to module entry function name
Return values:
MQERETURN_OK 
  • success.
MQERETURN_CLASSALIAS_ADD_FAIL 
  • MQEREASON_CLASSALIAS_UNABLE_TO_ADD Could not add an entry to the table
MQERETURN_CLASSALIAS_ADD_FAIL 
  • MQEREASON_CLASSALIAS_ALLOC_FAIL Could not allocate space
MQERETURN_CLASSALIAS_ADD_FAIL 
  • MQEREASON_CLASSALIAS_NOT_MODIFIABLE The entry has already been defined by the system
MQERETURN_CLASSALIAS_LOCK_FAIL 
  • MQEREASON_NA Could not lock the mapping tables
other 
  • other common error codes caused by invalid supplied parameters
Warning:
It is the caller's responsibility to free the input strings.


Generated Thu Aug 11 23:27:09 2005 for Websphere MQ Everyplace for Multiplatforms C Programming Reference