Application.OnTime Method
| SharePoint Designer Developer Reference |
Starts a background timer that runs a macro on the specified date at the specified time.
Syntax
expression.OnTime(When, Name, Tolerance)
expression Required. A variable that represents an Application object.
Parameters
| Name | Required/Optional | Data Type | Description |
|---|---|---|---|
| When | Required | Variant | The time at which the macro is to be run. |
| Name | Required | String | The name of the macro to be run. |
| Tolerance | Optional | Variant | The maximum time (in seconds) that can elapse before a macro that wasn't run at the time specified by When is canceled. Macros may not always run at the specified time. For example, if a dialog box is being displayed, the macro is delayed until the application has completed the task. If this argument is 0 (zero) or omitted, the macro is run regardless of how much time has elapsed since the time specified by When. |
Remarks
The When parameter can be a string that specifies a time (for example, "4:30 pm" or "16:30"), or it can be a serial number returned by a function such as TimeValue or TimeSerial (for example, TimeValue("2:30 pm") or TimeSerial(14, 30, 00)). You can also include the date (for example, "6/30 4:15 pm" or TimeValue("6/30 4:15 pm")).
Use the sum of the return values of the Now function and either the TimeValue or TimeSerial function to set a timer to run a macro a specified amount of time after the statement is run. For example, use Now+TimeValue("00:05:30") to run a macro 5 minutes and 30 seconds after the statement is run.
Use the complete macro path to ensure that the correct macro is run (for example, "Project.Module1.Macro1"). For the macro to run, the document or template must be available both when the OnTime method is run and when the time specified by When arrives.
You can use only one background timer set by the OnTime method. If you start another timer before an existing timer runs, the existing timer is canceled.
See Also