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

MQe_Trace.h File Reference


Detailed Description

API header file for the trace functions.


Data Structures

struct  MQeTraceParms
 Structure used for setting/getting the trace configuration. More...


Defines

#define SET_TRACEPARMS_INIT_VAL(traceParms)

Functions

MQERETURN mqeTrace_setOptions (MQeExceptBlock *pExceptBlock, MQeTraceParms *pTraceParms)
 This function sets the MQe trace options.

MQERETURN mqeTrace_getOptions (MQeExceptBlock *pExceptBlock, MQeTraceParms *pTraceParms)
 This function gets the MQe trace options.

MQERETURN mqeTrace_write (MQeExceptBlock *pExceptBlock, MQECHAR *pInfo)
 This function writes a pre-formatted user string to the trace.


Define Documentation

#define SET_TRACEPARMS_INIT_VAL traceParms   
 

Advanced option to control exactly how much trace is generated


Function Documentation

MQERETURN mqeTrace_setOptions MQeExceptBlock   pExceptBlock,
MQeTraceParms   pTraceParms
 

This function sets the MQe trace options.

Parameters:
pExceptBlock  [in/out] pointer to a pre-allocated MQeExceptBlock structure.
pTraceParms  [in] pointer to an MQeTraceControl block which affects the operation of the trace.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
Return values:
MQERETURN_OK  Operation successful

MQERETURN mqeTrace_getOptions MQeExceptBlock   pExceptBlock,
MQeTraceParms   pTraceParms
 

This function gets the MQe trace options.

Parameters:
pExceptBlock  [in/out] pointer to a pre-allocated MQeExceptBlock structure.
pTraceParms  [out] pointer to an MQeTraceControl block which affects the operation of the trace.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
Return values:
MQERETURN_OK  Operation successful

MQERETURN mqeTrace_write MQeExceptBlock   pExceptBlock,
MQECHAR *    pInfo
 

This function writes a pre-formatted user string to the trace.

Parameters:
pExceptBlock  [in/out] pointer to a pre-allocated MQeExceptBlock structure.
pInfo  [in] pointer to a null-terminated string containing the text to be written to the trace. Note: Formatted string must be no greater than 4096 bytes in size.
Precondition:
pExceptBlock should point to a pre-allocated MQeExceptBlock structure (no error information will be returned if pExceptBlock is null).
Return values:
MQERETURN_OK  Operation successful


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