SET_TIMER Built-in
Description
Changes the settings for an existing timer. You can modify the interval, the repeat parameter, or both.
Syntax
SET_TIMER
(timer_id Timer,
milliseconds NUMBER,
iterate NUMBER);
SET_TIMER
(timer_name VARCHAR2,
milliseconds NUMBER,
iterate NUMBER);
Built-in Type unrestricted procedure
Enter Query Mode yes
Parameters
- timer_id
-
- Specifies the unique ID that Oracle Forms assigns when it creates the
timer, specifically as a response to a successful call to the CREATE_TIMER
Built-in. Use the FIND_TIMER Built-in to return the ID to an appropriately
typed variable. The data type of the ID is Timer.
-
- timer_name
-
- Specifies the name you gave the timer when you defined it. The data type
of the name is VARCHAR2.
-
- milliseconds
-
- Specifies the duration of the timer in milliseconds. The range of values
allowed for this parameter is 1 to 2147483648 milliseconds. Values > 2147483648
will be rounded down to 2147483648. Note that only positive numbers are allowed.
The data type of the parameter is NUMBER. See Restrictions below for more
information.
NO_CHANGE Specifies that the milliseconds property
is to remain at its current setting.
-
- iterate
-
- Specifies the iteration of the timer.
REPEAT Indicates that the timer should repeat
upon expiration. Default.
NO_REPEAT Indicates that the timer should not
repeat upon expiration, but is to be used once only, until explicitly called
again.
NO_CHANGE Specifies that the iterate property
is to remain at its current setting.
SET_TIMER Restrictions
- Values > 2147483648 will be rounded down to 2147483648.
- A value less than 1 results in a runtime error.
- A value greater than the stated upper bound results in an integer overflow.
- Milliseconds cannot be expressed as a negative number.
- No two timers can share the same name in the same form instance, regardless
of case.
- If there is no When-Timer-Expired trigger defined at the execution of a
timer, Oracle Forms returns an error.
- If there is no When-Timer-Expired trigger defined at the execution of a
timer, and the timer is a repeating timer, subsequent repetitions are canceled,
but the timer is retained.
SET_TIMER Example
/*
** Built-in: SET_TIMER
** Example: See FIND_TIMER
*/