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

MQe_Native_ReturnCodes.h File Reference


Detailed Description

The WMQe return/reason code definitions.

This lists all the return codes and reason codes in the system. Information about using the codes is available in Error Handling

Note:
These exception codes are only valid for the Native C Client The Bindings release codes have different numeric values. Symbolic names have remained consistent between the two.

Defines

#define MQERETURN_USER_BASE
 Returned code section for example code. If in your application you want to use an form of reason code, you can be assured that no code from Websphere MQSeries Everyplace will have a value of 0x80000000 or greater.

#define MQEREASON_USER_BASE
 Reason code section for example code.


Typedefs

typedef enum MQEREASON MQEREASON
 MQe Exception Reason codes.


Enumerations

enum  MQERETURN {
  MQERETURN_OK,
  MQERETURN_NOTHING_TO_DO ,
  MQERETURN_ALLOCATION_FAIL,
  MQERETURN_BUFFER_OVERFLOW,
  MQERETURN_NOT_SUPPORTED,
  MQERETURN_SESSION_NOT_INITIALIZED,
  MQERETURN_INVALID_ARGUMENT,
  MQERETURN_OBJ_CREATE_FAIL,
  MQERETURN_OSA_MEMORY_ERROR,
  MQERETURN_OSA_MQESTRING_ERROR ,
  MQERETURN_RULES_ERROR,
  MQERETURN_RULES_DISALLOWED_BY_RULE ,
  MQERETURN_API_FIELD_TYPE_MISMATCH,
  MQERETURN_NOT_FOUND,
  MQERETURN_INVALID_HANDLE,
  MQERETURN_DATA,
  MQERETURN_TYPE,
  MQERETURN_DUPLICATE,
  MQERETURN_NOT_ALLOWED,
  MQERETURN_INTERNAL_ERROR,
  MQERETURN_FIELDSHELPER_UNWRAP_MSG_FAIL,
  MQERETURN_FIELDSHELPER_WRAP_MSG_FAIL,
  MQERETURN_FIELDSHELPER_GET_MSG_UIDFIELDS_FAIL,
  MQERETURN_FIELDSHELPER_GET_MSG_ORGQMGR_FAIL,
  MQERETURN_FIELDSHELPER_GET_MSG_TIMESTAMP_FAIL
}
enum  MQEREASON {
  MQEREASON_OK,
  MQEREASON_OK_JAVA,
  MQEREASON_NA ,
  MQEREASON_INVALID_PARAM1,
  MQEREASON_INVALID_PARAM2,
  MQEREASON_INVALID_PARAM3,
  MQEREASON_INVALID_PARAM4,
  MQEREASON_INVALID_PARAM5,
  MQEREASON_INVALID_PARAM6,
  MQEREASON_INVALID_PARAM7,
  MQEREASON_INVALID_PARAM8,
  MQEREASON_INVALID_PARAM9,
  MQEREASON_NOT_FOUND ,
  MQEREASON_INTERNAL_ERROR ,
  MQEREASON_ORIGIN_QM_ALREADY_SET ,
  MQEREASON_NOQUEUE_VECTOR,
  MQEREASON_REGISTRY_DEFINED_ALREADY,
  MQEREASON_REGISTRY_NOT_DEFINED_ALREADY ,
  MQEREASON_REGISTRY_DATA_VERSION ,
  MQEREASON_QMGR_UPDATE_PERSIST_FAILURE,
  MQEREASON_TRANSPORTER_COMMS_FAILURE ,
  MQEREASON_RULES_CONTINUE_SEARCH,
  MQEREASON_RULES_END_SEARCH
}

Define Documentation

#define MQEREASON_USER_BASE
 

Reason code section for example code.

If in your application you want to use a form of reason code, you can be assured that no code from MQSeries Everyplace will have a value of 0x80000000 or greater.


Typedef Documentation

MQEREASON
 

MQe Exception Reason codes.

All the possible reason codes. Note that not all of these are applicable to every MQERETURN code.

When you get MQERETURN_OK then the reason code will be MQEREASON_OK. If there is no reason code for a particular return code, you'll get MQEREASON_NA (Not Applicable).

A number of the reason codes are to represent internal errors. Please contact your IBM Service Representative if one of these internal errors occurs.

Format of these is as follows

0x ## ## ## ## # If 0xf indicates that this reason code is Java comptable. & with 0xFFF to get java code

# ## Base code of the error


Enumeration Type Documentation

enum MQERETURN
 

Enumeration values:
MQERETURN_OK  No errors
MQERETURN_NOTHING_TO_DO  No errors because the conditions meant that no processing could be done
MQERETURN_ALLOCATION_FAIL  not enough heap space
MQERETURN_BUFFER_OVERFLOW  buffer supplied not big enough
MQERETURN_NOT_SUPPORTED  functionality not supported
MQERETURN_SESSION_NOT_INITIALIZED  Internal session handle not initialized
MQERETURN_INVALID_ARGUMENT  Invalid parameter supplied by external users
MQERETURN_OBJ_CREATE_FAIL  Exception raised raised outside MQe
MQERETURN_OSA_MEMORY_ERROR  Failed to initialize OSA
MQERETURN_OSA_MQESTRING_ERROR  Failed to create a MQeString
MQERETURN_RULES_ERROR  internal error from a rules function
MQERETURN_RULES_DISALLOWED_BY_RULE  user-returned return code from a rules function
MQERETURN_API_FIELD_TYPE_MISMATCH  Field type mismatch
MQERETURN_NOT_FOUND  Field not found
MQERETURN_INVALID_HANDLE  Invalid vector handle
MQERETURN_DATA  Invalid byte data
MQERETURN_TYPE  Wrong type of entry/handle
MQERETURN_DUPLICATE  Duplicated entry/handle
MQERETURN_NOT_ALLOWED  Access denied
MQERETURN_INTERNAL_ERROR  internal error
MQERETURN_FIELDSHELPER_UNWRAP_MSG_FAIL  unwrap message failure
MQERETURN_FIELDSHELPER_WRAP_MSG_FAIL  wrap message failure
MQERETURN_FIELDSHELPER_GET_MSG_UIDFIELDS_FAIL  get message UID failure
MQERETURN_FIELDSHELPER_GET_MSG_ORGQMGR_FAIL  get origin QMgr name failure
MQERETURN_FIELDSHELPER_GET_MSG_TIMESTAMP_FAIL  get time stamp failure

enum MQEREASON
 

Enumeration values:
MQEREASON_OK  No Error
MQEREASON_OK_JAVA  No Error
MQEREASON_NA  Not applicable
MQEREASON_INVALID_PARAM1  Parameter 1 is invalid
MQEREASON_INVALID_PARAM2  Parameter 2 is invalid
MQEREASON_INVALID_PARAM3  Parameter 3 is invalid
MQEREASON_INVALID_PARAM4  Parameter 4 is invalid
MQEREASON_INVALID_PARAM5  Parameter 5 is invalid
MQEREASON_INVALID_PARAM6  Parameter 6 is invalid
MQEREASON_INVALID_PARAM7  Parameter 7 is invalid
MQEREASON_INVALID_PARAM8  Parameter 8 is invalid
MQEREASON_INVALID_PARAM9  Parameter 9 is invalid
MQEREASON_NOT_FOUND  Indicates the item search for is not present
MQEREASON_INTERNAL_ERROR  Internal processing failed in a user recoverable manner
MQEREASON_ORIGIN_QM_ALREADY_SET  Origin QM already set _ may be attempt to resend message not allowed
MQEREASON_NOQUEUE_VECTOR  Inquire specified Queue Info, but no vector supplied
MQEREASON_REGISTRY_DEFINED_ALREADY  Tried to create a QM registry already there
MQEREASON_REGISTRY_NOT_DEFINED_ALREADY  Tried to open QM but registry wasn't there
MQEREASON_REGISTRY_DATA_VERSION  A queue manager has been asked to start from a registry which it considers to be back-level
MQEREASON_QMGR_UPDATE_PERSIST_FAILURE  An Update to the QM Failed - updated state has not been persited.
MQEREASON_TRANSPORTER_COMMS_FAILURE  There has been a comms failure -please consult trace for more info
MQEREASON_RULES_CONTINUE_SEARCH  Reject got message but continue search
MQEREASON_RULES_END_SEARCH  Reject got message and end search


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