UTCMode Method

9.4D, PLBCMP GUI Only

The UTCMode method initializes the EDITDATETIME object to the UTC time or the current workstation local time. This method uses the following format:

Where:

label

Optional. A Program Execution Label.

object

Required. An EDITDATETIME object that is accessed.

return

Optional. A Numeric Variable that indicates the success of the method.

mode

Optional. A Numeric Variable or decimal value that specifies the the new UTC state value to be applied.

Flags Affected: EOS, OVER, ZERO

Note the following:

1. If the value returned is zero, the ZERO Condition Flag is set.

2. The EOS Condition Flag is always cleared.

3. The OVER Condition Flag is set if the {return} variable it too small to receive the method result without truncation.

4. The {mode} value can be specified as 0, 1, or 2 with the following action:

 

Value	Scrolls the text ...
0	The UTC state is turned off and the EDITDATETIME object is initialized to the current workstation local time.
1	The UTC state is turned on and the EDITDATETIME object is initialized to the UTC time only when the SETPROP TEXT property is set to a null string.
2	Same action as for value 1. his value is only ud to set the EDITDATETIME state to a value that reflects an original UTC state that existed when an EDITDATETIME object was created.

 

 

 

5. When using the PL/B Web Server, this method is not supported.

See Also: Method Syntax, EDITDATTIME Methods