GetSnapshotEventPipe2 Method (IPointListEvPipeAccess Interface)

                    

 

 

This method retrieves the snapshot EventPipe associated with a PointList. If there are some points in the point list that cannot be signed up with the server, an EventPipe with partial signup is returned together with a PIErrors collection containing the point level errors.

Syntax

object.GetSnapshotEventPipe2 ErrorList

The object placeholder is an object that evaluates to a reference to an IPointListEvPipeAccess interface. This interface can be obtained from the ListData object.

 

The GetSnapshotEventPipe2 method syntax has these parts:

Part

Description

object An object expression that evaluates to a IPointListEvPipeAccess object.
ErrorList

A retuned PIErrors collection containing point level signup error if any. Collection count of zero means no error.

 

Remarks

Check the ErrorList error count to determine if there is some points failed to get sign up. If the count is greater than zero, get the individual PIError object to get information about which point has failed. The cause field in the PIError object contains the pathname of the point. The description field contains the error description.


Trappable Errors

In addition to generic errors (such as Out of Memory), the following errors may occur:

Error

Description

pseEVENTPIPECREATE Unable to create a new EventPipe object.
pseSERVERPOINTIDMAP Unable to create a mapping of servers and point IDs to execute the call.
pseBUILDSIGNUPERRFAIL Unable to create a PIErrors collection to return point level errors.

 

Error

Description

E_INVALIDARG Some of the function argument are not valid.
pseEMPTYPOINTLIST PointList contains no point.
pseDISCONNECTEDOBJECT PointList is no longer connected to server.
E_ACCESSDENIED No read access to PI Server
pseDISCONNECTED Server can not be reached over the network.

 

Enabling Operational Intelligence