Pointwise Plugin SDK
Public Attributes | List of all members

The data sent by plugins for progress messages. More...

#include <apiPWP.h>

Public Attributes

PWP_UINT32 value
 The progress value. More...
 

Detailed Description

The data sent by plugins for progress messages.

Note
The framework supports a 2-level progress interface. The progress message sequence is shown below:
PWP_MSGID_PROGBEGIN(value=3) // 3 level1 steps
PWP_MSGID_PROGSTATUS(value=10) // step 1 at 10%
PWP_MSGID_PROGSTATUS(value=20) // step 1 at 20%
...
PWP_MSGID_PROGSTATUS(value=100) // step 1 at 100%
PWP_MSGID_PROGSTATUS(value=-1) // start next step 2of3
PWP_MSGID_PROGSTATUS(value=10) // step 2 at 10%
PWP_MSGID_PROGSTATUS(value=20) // step 2 at 20%
...
PWP_MSGID_PROGSTATUS(value=100) // step 2 at 100%
PWP_MSGID_PROGSTATUS(value=-1) // start next step 3of3
PWP_MSGID_PROGSTATUS(value=10) // step 3 at 10%
PWP_MSGID_PROGSTATUS(value=20) // step 3 at 20%
...
PWP_MSGID_PROGSTATUS(value=100) // step 3 at 100%

Definition at line 528 of file apiPWP.h.

Member Data Documentation

◆ value

PWP_UINT32 PWP_MSG_PROGRESS::value

The progress value.

Note
The "meaning" of value depends on the which message is being used. The usage is shown in the table below:
plugin will set framework will
For PWP_MSGID_x msg.value = return
-------------------- ------------------ ---------------------
PWP_MSGID_PROGBEGIN total L1 steps >0 if op can continue
PWP_MSGID_PROGSTATUS 0-100 level2 prog >0 if op can continue
PWP_MSGID_PROGSTATUS -1 next level1 >0 if op can continue
PWP_MSGID_PROGEND 0 = fail, !0 = ok nothing
PWP_MSGID_PROGQUIT not used >0 if op canceled

Definition at line 546 of file apiPWP.h.

Referenced by PwuSendProgressMsg().


The documentation for this struct was generated from the following file: