Progress Reporting

Collaboration diagram for Progress Reporting:

Functions
PWP_BOOL	PwuProgressBegin (const char api[], PWP_UINT32 totalSteps)
	Send a progress begin message (PWP_MSGID_PROGBEGIN) to the framework. More...
void	PwuProgressEnd (const char api[], PWP_BOOL ok)
	Send a progress end message (PWP_MSGID_PROGEND) to the framework. More...
PWP_BOOL	PwuProgressNextStep (const char api[])
	Send a progress "next step" message (PWP_MSGID_PROGSTATUS, value = -1) to the framework. More...
PWP_BOOL	PwuProgressQuit (const char api[])
	Send a progress query-quit message (PWP_MSGID_PROGQUIT) to the framework. More...
PWP_BOOL	PwuProgressStatus (const char api[], PWP_UINT32 complete, PWP_UINT32 total)
	Send a progress status message (PWP_MSGID_PROGSTATUS, value >= 0) to the framework. More...

Detailed Description

Bundle and send a progress 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 progress messages as required by the PWP-API.

See also

PWP_MESSAGECB, PWP_MSG_PROGRESS

Function Documentation

PwuProgressBegin()

PWP_BOOL PwuProgressBegin	(	const char	api[],
		PWP_UINT32	totalSteps
	)

Send a progress begin message (PWP_MSGID_PROGBEGIN) to the framework.

Parameters

api	The API sending the message. One of the values returned from PwpEnumAPIs().
totalSteps	The total number of major steps.

Returns

PWP_TRUE if framework wants to continue. PWP_FALSE if framework has aborted op.

Definition at line 152 of file apiPWPUtils.cxx.

References PWP_FALSE, PWP_MSGID_PROGBEGIN, PWP_TRUE, and PwuSendProgressMsg().

Referenced by caeuProgressInit(), and grdpProgressInit().

PwuProgressEnd()

void PwuProgressEnd	(	const char	api[],
		PWP_BOOL	ok
	)

Send a progress end message (PWP_MSGID_PROGEND) to the framework.

Parameters

api	The API sending the message. One of the values returned from PwpEnumAPIs().
ok	The progress status; Set to PWP_TRUE to continue. Set to PWP_FALSE to indicate operation failure and stop.

Returns

PWP_TRUE if framework wants to continue. PWP_FALSE if framework has aborted op.

Definition at line 163 of file apiPWPUtils.cxx.

References PWP_MSGID_PROGEND, and PwuSendProgressMsg().

Referenced by caeuProgressEnd(), and grdpProgressEnd().

PwuProgressNextStep()

PWP_BOOL PwuProgressNextStep

(

const char

api[]

)

Send a progress "next step" message (PWP_MSGID_PROGSTATUS, value = -1) to the framework.

Parameters

api	The API sending the message. One of the values returned from PwpEnumAPIs().

Returns

PWP_TRUE if framework wants to continue. PWP_FALSE if framework has aborted op.

Definition at line 189 of file apiPWPUtils.cxx.

References PWP_FALSE, PWP_MSGID_PROGSTATUS, PWP_TRUE, and PwuSendProgressMsg().

Referenced by caeuProgressBeginStep(), and grdpProgressEndStep().

PwuProgressQuit()

PWP_BOOL PwuProgressQuit

(

const char

api[]

)

Send a progress query-quit message (PWP_MSGID_PROGQUIT) to the framework.

Parameters

api	The API sending the message. One of the values returned from PwpEnumAPIs().

Returns

PWP_TRUE if framework has aborted op. PWP_FALSE if framework wants to continue.

Definition at line 200 of file apiPWPUtils.cxx.

References PWP_FALSE, PWP_MSGID_PROGQUIT, PWP_TRUE, and PwuSendProgressMsg().

PwuProgressStatus()

PWP_BOOL PwuProgressStatus	(	const char	api[],
		PWP_UINT32	complete,
		PWP_UINT32	total
	)

Send a progress status message (PWP_MSGID_PROGSTATUS, value >= 0) to the framework.

Parameters

api	The API sending the message. One of the values returned from PwpEnumAPIs().
complete	The number of completed sub-steps.
total	The total number of sub-steps in the current step.

Returns

PWP_TRUE if framework wants to continue. PWP_FALSE if framework has aborted op.

Definition at line 173 of file apiPWPUtils.cxx.

References PWP_FALSE, PWP_MSGID_PROGSTATUS, PWP_TRUE, and PwuSendProgressMsg().

Referenced by caeuProgressIncr(), and grdpProgressIncr().