Pointwise Plugin SDK
Functions
+ Collaboration diagram for Message Handling:

Functions

void caeuSendDebugMsg (CAEP_RTITEM *pRti, const char txt[], PWP_UINT32 code)
 Send a debug text message (PWP_MSGID_DEBUG) to the framework. More...
 
void caeuSendErrorMsg (CAEP_RTITEM *pRti, const char txt[], PWP_UINT32 code)
 Send an error text message (PWP_MSGID_ERROR) to the framework. More...
 
void caeuSendInfoMsg (CAEP_RTITEM *pRti, const char txt[], PWP_UINT32 code)
 Send an info text message (PWP_MSGID_INFO) to the framework. More...
 
void caeuSendWarningMsg (CAEP_RTITEM *pRti, const char txt[], PWP_UINT32 code)
 Send a warning text message (PWP_MSGID_WARNING) to the framework. More...
 

Detailed Description

Bundle and send a CAEP message back to framework.

These are the CAEP equivalents of the PwuSendXxxMsg() functions.

See also
PwuSendMsg(), PwuSendDebugMsg(), PwuSendInfoMsg(), PwuSendWarningMsg(), PwuSendErrorMsg(), PWP_MESSAGECB, PWP_MSG_TEXT

Function Documentation

◆ caeuSendDebugMsg()

void caeuSendDebugMsg ( CAEP_RTITEM pRti,
const char  txt[],
PWP_UINT32  code 
)

Send a debug text message (PWP_MSGID_DEBUG) to the framework.

Parameters
pRtiThe CAEP_RTITEM pointer passed into runtimeWrite().
txtThe message text.
codeThe API-defined message code.

Definition at line 211 of file apiCAEPUtils.cxx.

References PWU_RTITEM::apiInfo, PWP_APIINFO::name, CAEP_RTITEM::pApiData, and PwuSendDebugMsg().

Referenced by CaePlugin< MT >::sendDebugMsg(), and sendDiffTimeMsg().

◆ caeuSendErrorMsg()

void caeuSendErrorMsg ( CAEP_RTITEM pRti,
const char  txt[],
PWP_UINT32  code 
)

Send an error text message (PWP_MSGID_ERROR) to the framework.

Parameters
pRtiThe CAEP_RTITEM pointer passed into runtimeWrite().
txtThe message text.
codeThe API-defined message code.

Definition at line 238 of file apiCAEPUtils.cxx.

References PWU_RTITEM::apiInfo, PWP_APIINFO::name, CAEP_RTITEM::pApiData, and PwuSendErrorMsg().

Referenced by CaePlugin< MT >::sendErrorMsg().

◆ caeuSendInfoMsg()

void caeuSendInfoMsg ( CAEP_RTITEM pRti,
const char  txt[],
PWP_UINT32  code 
)

Send an info text message (PWP_MSGID_INFO) to the framework.

Parameters
pRtiThe CAEP_RTITEM pointer passed into runtimeWrite().
txtThe message text.
codeThe API-defined message code.

Definition at line 220 of file apiCAEPUtils.cxx.

References PWU_RTITEM::apiInfo, PWP_APIINFO::name, CAEP_RTITEM::pApiData, and PwuSendInfoMsg().

Referenced by CaePlugin< MT >::sendInfoMsg().

◆ caeuSendWarningMsg()

void caeuSendWarningMsg ( CAEP_RTITEM pRti,
const char  txt[],
PWP_UINT32  code 
)

Send a warning text message (PWP_MSGID_WARNING) to the framework.

Parameters
pRtiThe CAEP_RTITEM pointer passed into runtimeWrite().
txtThe message text.
codeThe API-defined message code.

Definition at line 229 of file apiCAEPUtils.cxx.

References PWU_RTITEM::apiInfo, PWP_APIINFO::name, CAEP_RTITEM::pApiData, and PwuSendWarningMsg().

Referenced by CaePlugin< MT >::sendWarningMsg().