Generates a character-separated list of information about a specified time zone ID.
You can obtain the active model's time zone ID using the GetModelTimeZoneId function. For a list of valid time zone codes, use the ListTimeZones function.
Syntax
GetTimeZoneInfo( TimeZone );
Parameters
| Parameter Name | Type | Description | Optional? | Default Value |
|---|---|---|---|---|
| TimeZone | String | A valid time zone ID. While this parameter is not optional, supplying an empty string will cause the function to use the time zone of the model that called it, where available. | No | n/a |
Output
If successful, the function will return a character-separated string list of information about the specified time zone. The data in this list is separated with pipe symbols (|), and represents the following:
| Field Description | Example Value |
|---|---|
| Zone ID | Marquesas Standard Time |
| Display name | (UTC-09:30) Marquesas Islands |
| UTC offset | -09:30:00 |
| Offset day part | 0 |
| Offset hour part | -9 |
| Offset millisecond part | 0 |
| Offset minute part | -30 |
| Offset second part | 0 |
| Offset total ticks | -342000000000 |
| Offset total days | -0.395833333333333 |
| Offset total hours | -9.5 |
| Offset total milliseconds | -34200000 |
| Offset total minutes | -570 |
| Offset total seconds | -34200 |
The raw CSV equivalent of this information is as follows:
Marquesas Standard Time|(UTC-09:30) Marquesas Islands|-09:30:00|0|-9|0|-30|0|-342000000000|-0.395833333333333|-9.5|-34200000|-570|-34200
If an invalid TimeZone is used, the function will return an error.