SetStartTime Method (PIBatch Objects)

               

The SetStartTime method modifies the start time of the batch object. Start time is the time the particular object begins activity. The start time of a PISubBatch should be within the start and end time of its parent PIUnitBatch. The start time of a PIUnitBatch should be within the start and end time of its parent PIBatch; this is not enforced. The start time, of course, must be older than the end time.  The start time of a batch object is accessed through the StartTime property.

Syntax

object.SetStartTime varStartTime

The SetStartTime method syntax has these parts:

Part

Description

object

An object expression that evaluates to an object in the Applies To list.

varStartTime

A VARIANT representing the start time. See settings below.

 

Remarks

All batch objects are stored in the PI UDS time series database. The start time is used as the storage time. Changing the start time causes the stored object to be moved in the database.

 

Settings

The possible values in the variant for varStartTime are:

Setting

Description

VT_BSTR

A Variant containing a time/date string (currently in Microsoft formats)

VT_DATE

A Variant containing a DATE representing a local date on the current system

VT_R4,VT_R8,VT_I2, VT_I4

A Variant containing a number representing seconds since 1970 UTC.

VT_DISPATCH, VT_UNKNOWN

A Variant containing a reference to a PITime object

Enabling Operational Intelligence