RemoveSignUp Method (IEventPipe2 Interface)

                    

 This method provides a mechanism to instruct the EventPipe to stop monitoring certain items.  For example, an EventPipe retrieved from a PointList object will monitor and deliver events for the PIPoints in the PointList.  Subsequent changes to the PointList do not impact the EventPipe.  With this method, an application can remove PIPoint objects from the monitoring process.

Syntax

object.RemoveSignUp vtPrimary, vtSecondary

 

The RemoveSignUp method syntax has these parts:

Part Description
object An object expression that evaluates to an IEventPipe2 interface.
vtPrimary A Variant containing the items to be removed from monitoring.  See the Settings below for the supported arguments for each EventPipe type.
vtSecondary A Variant containing additional information required to support the monitoring removal.  See the Settings below for the supported arguments for each EventPipe type.


Settings

EventPipe Type vtPrimary vtSecondary
PointList (EventPipe and ArchiveEventPipe) PIPoint Nothing
PointList (EventPipe and ArchiveEventPipe) PointList Nothing

Remarks

An EventPipe retrieved from a PointList object will monitor and deliver events for the PIPoints in the PointList.  Subsequent changes to the PointList do not impact the EventPipe.  With this method, an application can remove PIPoint objects from the monitoring process.

Removing a point that was not previously signed up does not generate an error. 

In versions prior to 1.4, when a user explicitly closes a server used by an EventPipe the PI-SDK marks the EventPipe as a disconnected object. For an EventPipe connected to multiple servers, closing any one of the servers will mark the entire EventPipe as a disconnected object. Further method calls on the EventPipe will return a pseDISCONNECTEDOBJECT error, except in the case of ListSignup for an EventPipe of type of eptPointList or eptPointListArchive. Version 1.4 of the PI-SDK removes this restriction.  See the help page on Disconnected Objects for more details.

Trappable Errors

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

Error Description
pseEVPSIGNUPTYPENOTSUP EventPipe signup input type not supported.
pseEVPIPENOTFOUND Event pipe not found.
pseCONSUMERINIT The consumer was not properly initialized.
pseDISCONNECTEDOBJECT Event Pipe is no long connected to the server.
pseSERVERSIGNUPSREMOVE Failed to remove server signups.  See Description field of extended error object for details.

Enabling Operational Intelligence