Function ProUITimerCreate
Description
Adds a new Timer to Creo Parametric. A Timer can be used to defer an action to a later stage. This function registers the Timer object, to be done only once during a Creo Parametric session for each timer. Subsequent calls to this function for previously registered timer name return an error. See also ProUIDialogTimerStart() Note: This function can be used only in dll mode, otherwise its behavior is unpredictable.
Synopsis
#include <ProUIDialog.h>
ProUITimerCreate | |
( ProUITimerAction action /* (In) See ProUITimerAction type definition. Note that the action callback does not return a value. The action is invoked only once per each call of ProUIDialogTimerStart. If the application wants to be called again, it should invoke ProUIDialogTimerStart again, possibly from the action callback. Note that you must not Activate/Open a dialog from this action CB. */ ProAppData appdata /* (In) User data to be passed to the action function. */ ProName timer_name /* (In) Name of timer. */ ProUITimerID * timer_id /* (Out) The id of the timer to be used with ProUIDialogTimerStart */ ) |
Returns
The function successfully create a timer. | |
One of the input arguments is not valid. | |
The timer_name is longer than 32 Characters. | |
The timer_name is in use. |
User Guide References