Pointwise Plugin SDK
Functions
+ Collaboration diagram for Message Handling:

Functions

void PwuSendDebugMsg (const char api[], const char txt[], PWP_UINT32 code)
 Send a debug text message (PWP_MSGID_DEBUG) to the framework. More...
 
void PwuSendErrorMsg (const char api[], const char txt[], PWP_UINT32 code)
 Send an error text message (PWP_MSGID_ERROR) to the framework. More...
 
void PwuSendInfoMsg (const char api[], const char txt[], PWP_UINT32 code)
 Send an info text message (PWP_MSGID_INFO) to the framework. More...
 
PWP_UINT32 PwuSendMsg (const char api[], PWP_ENUM_MSGID id, void *pMsg)
 Send a message from an api. More...
 
void PwuSendWarningMsg (const char api[], const char txt[], PWP_UINT32 code)
 Send a warning text message (PWP_MSGID_WARNING) to the framework. More...
 

Detailed Description

Bundle and send a text message back to framework.

The SDK implements the PwpSetMessageCallback() and PwpGetMessageCallback() API functions. If any framework message callbacks are registered, these calls will bundle and route the text messages as required by the PWP-API.

See also
PWP_MESSAGECB, PWP_MSG_TEXT

Function Documentation

◆ PwuSendDebugMsg()

void PwuSendDebugMsg ( const char  api[],
const char  txt[],
PWP_UINT32  code 
)

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

Parameters
apiThe API sending the message. One of the values returned from PwpEnumAPIs().
txtThe message text.
codeThe API-defined message code.

Definition at line 111 of file apiPWPUtils.cxx.

References PWP_MSGID_DEBUG, and PwuSendTextMsg().

Referenced by caeuSendDebugMsg(), and grdpSendDebugMsg().

◆ PwuSendErrorMsg()

void PwuSendErrorMsg ( const char  api[],
const char  txt[],
PWP_UINT32  code 
)

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

Parameters
apiThe API sending the message. One of the values returned from PwpEnumAPIs().
txtThe message text.
codeThe API-defined message code.

Definition at line 132 of file apiPWPUtils.cxx.

References PWP_MSGID_ERROR, and PwuSendTextMsg().

Referenced by caeuSendErrorMsg(), and grdpSendErrorMsg().

◆ PwuSendInfoMsg()

void PwuSendInfoMsg ( const char  api[],
const char  txt[],
PWP_UINT32  code 
)

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

Parameters
apiThe API sending the message. One of the values returned from PwpEnumAPIs().
txtThe message text.
codeThe API-defined message code.

Definition at line 118 of file apiPWPUtils.cxx.

References PWP_MSGID_INFO, and PwuSendTextMsg().

Referenced by caeuSendInfoMsg(), and grdpSendInfoMsg().

◆ PwuSendMsg()

PWP_UINT32 PwuSendMsg ( const char  api[],
PWP_ENUM_MSGID  id,
void *  pMsg 
)

Send a message from an api.

Generic form of the function. Other, more specific forms are provided for common messages.

Parameters
apiThe API sending the message. One of the values returned from PwpEnumAPIs().
idThe message type id.
pMsgThe message type specific data.

Definition at line 71 of file apiPWPUtils.cxx.

References PWP_MESSAGECB_DEFAULT, PWP_MESSAGECB_SPY, and PwuFindApiMsgCB().

Referenced by PwuSendProgressMsg(), and PwuSendTextMsg().

◆ PwuSendWarningMsg()

void PwuSendWarningMsg ( const char  api[],
const char  txt[],
PWP_UINT32  code 
)

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

Parameters
apiThe API sending the message. One of the values returned from PwpEnumAPIs().
txtThe message text.
codeThe API-defined message code.

Definition at line 125 of file apiPWPUtils.cxx.

References PWP_MSGID_WARNING, and PwuSendTextMsg().

Referenced by caeuSendWarningMsg(), and grdpSendWarningMsg().