DTListTimeZones

Function Block - List the time zones available on the controller.

This function block is specific for PCMM2G only.

Inputs

Input	Data Type	Range	Unit	Default	Description
Execute	BOOL	FALSE, TRUE	N/A	No default	If TRUE, request to read the available time zones.
TimeZones	STRING[ ]	No range	N/A	No default	An array where the list of time zones available on the system are copied. This is effectively an output parameter, but because it is an array, it must be an input.

Input

Data Type

Range

Unit

Default

Description

Execute

BOOL

FALSE, TRUE

N/A

No default

If TRUE, request to read the available time zones.

TimeZones

STRING[ ]

No range

N/A

No default

An array where the list of time zones available on the system are copied.

This is effectively an output parameter, but because it is an array, it must be an input.

Outputs

Output	Data Type	Range	Unit	Description
Done	BOOL	FALSE, TRUE	N/A	If TRUE, the command completed successfully.
Error	BOOL	FALSE, TRUE	N/A	If TRUE, an error has occurred.
ErrorID	DINT	No range	N/A	Indicates the error if Error output is TRUE. Error Codes 23 = Internal error. See the controller log for details. 15000 = Controller type does not support this function block.
TZCount	DINT	No range	N/A	The number of time zones on the system.

Remarks

None

FBD Language Example

FFLD Language Example

IL Language Example

Not available.

ST Language Example

// read the list of supported time zones
Inst_DTListTimeZones( bListDTZones, TimeZones );
if NOT Inst_DTListTimeZones.Error then
   TZCount := Inst_DTListTimeZones.TZCount;
else
   ErrorID := Inst_DTListTimeZones.ErrorID;
end_if;

if  Inst_DTListTimeZones.Done then
   bListDTZones := false;
end_if;