ArchiveEventPipe Property (IPIData2 interface)

                    

 

The ArchiveEventPipe property returns an object that supports the EventPipe interface.  The property is obtained from the IPIData2 secondary interface which is supported by the PIPoint.Data object.  The returned EventPipe tracks changes to the archive on the server made by any program. This is useful when you need to keep track of changes to a point's history values, for example maintaining a consistent cache of values.

The ArchiveEventPipe tracks four kinds of updates.  The EventPipe interface provides methods to view and extract the incoming events as PIEventObjects.  These objects support an Action property which is used to describe the type of update the event represents.  The Action property takes values from the EventActionConstants enumeration.  See the settings section below for a list of Action types and their meaning.

Syntax

object.ArchiveEventPipe

The object placeholder is an object expression that evaluates to a IPIData2 interface, obtained from a PIData object.

Settings

The possible values for the Action property of a PIEventObject returned from an EventPipe obtained from this property are:

 

Action Description
eaAdd An event has been appended to the archive.  This is the normal mode for events that pass compression tests as they move from the snapshot to the archive.   
eaAddNoReplace An event has been added to the archive using "No Replace" mode.  This mode allows the event to be added as long as there is not already an event at the specified time.  Typically out of order snapshots are sent to the archive with this mode.
eaDelete An existing event has been deleted from the archive.  The EventData property holds the value of the deleted event.
eaEdit An existing event in the archive has been edited.  The EventData property holds the new value of the event.

Remarks

The ArchiveEventPipe is not supported on PI2 servers. 

Enabling Operational Intelligence