Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Plant SCADA

IPen​.LocalTime [Property][Get/Set]

  • Last UpdatedJul 18, 2023
  • 1 minute read

Get or Set whether the axis will display time in the computers current local format or in UTC (Universal Time Coordinate).

Defined As

  • [VBA] Boolean LocalTime

  • [Cicode] INT LocalTime

  • [C++] VARIANT_BOOL LocalTime

Execution Result

If the property get/set succeeds the return value will be Success. If the return variable is bad, the return value will be InvalidArgument. If the pen is deleted, the return value will be GeneralFailure.

Limits

  • True (-1): Local format

  • False (0): UTC format

Calling Syntax

Assumes you have passed a valid pen object into the function.

[VBA]

Sub Example(pen As Object)
Dim localTime As Boolean
`Getting Property value
localTime = pen.LocalTime
`Display time in UTC
pen.LocalTime = False
End Sub

[Cicode]

FUNCTION Example(OBJECT hPen)
INT bLocalTime;
// Getting current property value
bLocalTime = _ObjectGetProperty(hPen, "LocalTime");
// Display time in UTC
_ObjectSetProperty(hPen, "LocalTime", 0);
END

In This Topic
Related Links
TitleResults for “How to create a CRG?”Also Available in