SetTagOffsetMS

The SetTagOffsetMS method sets the amount of time that the trend curve of the currently selected tag will be shifted from the actual time.

Syntax

[Result=] aaHistClientTrend.SetTagOffsetMS(message serverName, message tagName, integer milliseconds);

Parameters

serverName

The name of the server.

tagName

The name of the tag.

milliseconds

The offset, for the shift in milliseconds. The offset can be positive or negative. For more information, see Using Time Offsets to Compare Data.

Return Value

Returns a discrete value. Returns True if the set was successful; otherwise, returns False.

Due to the limited range for integer values, the maximum offset you can set using this property is about 29 days. For larger offsets, use the CurrentTagStartDate property.

Remarks

If the specified tag is shown in the chart multiple times, the method uses the first instance that was added.