AddSignUp2 Method (IEventPipe3 Interface)

                    

 

Add new monitoring targets to an event pipe and return server errors for specific targets.

This method can be used to add multiple signups to an event pipe in a single call. If some of the passed monitoring targets are rejected by the server the remaining valid targets are still added and monitored.  The method supports the standard error returns as well as a PIErrors collection that will contain any target specific errors indicating why certain targets could not be added.

 

Syntax

object.AddSignUp2 vtPrimary, vtSecondary, ErrorList

The object placeholder is an object that evaluates to a reference to an IEventPipe3 interface.  This interface can be obtained from the EventPipe object or an IEventPipe2 interface.

 

The AddSignUp2 method syntax has these parts:

Part

Description

object An object expression that evaluates to a IEventPipe3 object.
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.

ErrorList

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


Settings

EventPipe Source EventPipe Type vtPrimary vtSecondary
PointList EventPipe PIPoint or PointList Nothing
PointList ArchiveEventPipe PIPoint or 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 an existing EventPipe with additional PIPoint objects to be monitored.  Note only EventPipes obtained from a PointList are supported by this call currently.

In PI-SDK versions prior to 1.4, when a program or user explicitly closes any of the servers used by an active EventPipe the entire EventPipe becomes a disconnected object. Subsequent method calls to the EventPipe will return a pseDISCONNECTEDOBJECT error.  See the help page on Disconnected Objects for more information.

When calling this method, check the returned ErrorList Count property to determine if any targets were rejected. If the count is greater than zero, retrieve the individual PIError objects to discover which targets failed. In the case of EventPipes retrieved from a PointList, the Cause property in each PIError object contains the pathname of the rejected point. The Description property contains the error description.


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.
pseBUILDSIGNUPERRFAIL Unable to create a PIErrors collection to return point level errors.
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