AddSignUp Method (IEventPipe2 Interface)

                    

 

This method provides a mechanism to instruct the EventPipe to monitor additional items. 

Syntax

object.AddSignUp vtPrimary, vtSecondary

 

The AddSignUp method syntax has these parts:

Part Description
object An object expression that evaluates to an IEventPipe2  interface.
vtPrimary A Variant containing the additional items to be monitored.  See the Settings below for the supported arguments for each EventPipe type.
vtSecondary A Variant containing additional information required to support the monitoring addition.  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 provide additional PIPoint objects to be monitored.

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.
pseCONSUMERSIGNUP Consumer failed to sign up for exceptions.
pseSERVERSIGNUPADD Failed to register event sign-ups with server
pseINTERNALSERVERSIGNUPADD Failed to add server-idmap pair to internal map.
pseINTERNALSIGNUPADD Failed to add sign up to internal map.
pseDISCONNECTEDOBJECT Event Pipe is no long connected to the server.
pseCNSMRFROMSRVREVPIPEFAILED Failed to find a consumer given a server ID and an event pipe ID.

Enabling Operational Intelligence