TIME
Returns the time (in the specified order and format) that Enrichment began running the application (current or runtime).
By default, Enrichment evaluates the TIME function call only once per application for the first document. Thereafter, the time and its format remain constant. However, if the TIME function is called requesting the current time, the result will be reevaluated.
Syntax
TIME([format,style,when])
Arguments
| Argument | Description | Default | ||
|---|---|---|---|---|
| [format] | Indicates how Enrichment will return hours, minutes, and seconds. The style value modifies format, as follows: | S | ||
| format value | style set to Y | style set to N | ||
| C (Civil, 12-hour) | hh:mm:ss am | hh.mm.ss am | ||
| S (Short, 12-hour) | hh:mm am | hh.mm am | ||
| M (Military, 24-hour) | hh:mm:ss | hh.mm.ss | ||
| R (Hours/Mins, 24-hour) | hh:mm | hh.mm | ||
| H (Hours, 24-hour) | hh | hh | ||
| X (Military, 24-hour, with milliseconds) | hh:mm:ss.sss | hh.mm.ss.sss | ||
| [style] | One of the following: Y (yes) Use United States formatting. N (no) Use non-United States (international) formatting. |
Y | ||
| [when] | One of the following: B Begin time: the time when the job starts. C Current time: the time when the TIME function is called (current time stamp). |
B | ||
Results
| Result | Description |
|---|---|
| Return | The properly formatted time. |
| %%RC | Always set to 0. |
| %%RM | A null string (''). |
| %%RV | Always set to 0. |
Examples
In the following examples, the 24-hour clock time is 15:13:44.
| Function Call | Return | Function Call | Return |
|---|---|---|---|
| TIME(C,Y) | 02:13:44 pm | TIME(C,N) | 02.13.44 pm |
| TIME(S,Y) | 02:13 pm | TIME(S,N) | 02.13 pm |
| TIME(M,Y) | 15:13:44 | TIME(M,N) | 15.13.44 |
| TIME(R,Y) | 15:13 | TIME(R,N) | 15.13 |
| TIME(R,Y,B) | 15:13 | TIME(R,N,B) | 15.13 |
| TIME(C,Y,B) | 02:13:44 pm | TIME(C,Y,C) | 02:35:42 pm |