Category Custom user interface, Object ProUIDialog

Function ProUIDialogTimerStart


Description
Start the timer. After duration has passed (or longer), Creo will invoke the ProUITimerAction callback registered in ProUITimerCreate. You can call ProUIDialogTimerStart() again, from the ProUITimerAction. Note: This function can be used only in dll mode, otherwise its behavior is unpredictable.
Synopsis
#include <ProUIDialog.h>
ProErrorProUIDialogTimerStart(
char* dialog
/* (In)
The name of the dialog, each dialog can have only one timer simultaneously.
*/
ProUITimerID timer_id
/* (In)
the timer_id from ProUITimerCreate().
*/
int duration
/* (In)
In milliseconds, minimal value is 100
*/
ProBoolean write_in_trail_file
/* (In)
controls if the timer action happing to
*/
)
Returns
PRO_TK_NO_ERRORThe function successfully start a timer.
PRO_TK_BAD_INPUTSOne of the input arguments is not valid.
PRO_TK_E_IN_USEThere is an activae timer for this dialog.
PRO_TK_E_NOT_FOUNDThe timer_id was not found.
PRO_TK_GENERAL_ERRORThe function failed to start a timer.

Manual References:

  1. User Interface: Dialogs: Dialog Operations
  2. User Interface: Dialogs: Dialog Operations