ListSignUps Method (IEventPipe2 Interface)

                    

This method provides a list of the items in an EventPipe that are currently being monitored.  The method returns a SAFEARRAY of Variants containing the individual items.  The type of these items varies depending on the source of the EventPipe.  See the Settings section for details.

Syntax

object.ListSignUps vtPrimary, vtSecondary

 

The ListSignUps method syntax has these parts:

Part Description
object An object expression that evaluates to an IEventPipe2  interface.
vtPrimary A SAFEARRAY of Variant containing the items being monitored by the EventPipe. See Settings below for the type of information to expect for different EventPipe types.  Normally, the method returns a SAFEARRAY contain one element with the element being the object listed in the Settings table. If the EventPipe is disconnected, see Remark below for details.
vtSecondary A SAFEARRAY of Variant containing additional information for each item.  Currently, the method returns a SAFEARRAY contain one element of an empty Variant.


Settings

EventPipe Type

 

Description Returned Object in vtPrimary Comments
eptPIPoint Snapshot events PIpoint used to create the eventpipe  
eptPIPoints Point database update events PIPoints Implemented for PI3 only
eptPointList Snapshot events PointList containing all the pipoints being monitored See Remark below for disconnected Eventpipe behavior.
eptModuleDB Module change events ModuleDB  
eptBatchDB Batch change events BatchDB  
eptTransferRecordDB Transfer record events TransferRecordDB  
eptCampaignDB Campaign events   Not Implemented
eptUnitBatch Unit batch events PIModule that was used to create the eventpipe  
eptPIPointArchive Archive change events PIpoint used to create the eventpipe  
eptPointListArchive Archive change events PointList containing all the pipoints being monitored See Remark below for disconnected Eventpipe behavior.

Remarks

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.

For these two types of EventPipe in the disconnected state, the ListSignups method will return a SAFEARRAY of strings containing the list of tags monitored by the EventPipe Each string representing a signup tag is provided in the format  "\\Srvname\?ptid". This is a format  recognizable by the PISDK.GetPoint method.

After reconnecting to the server, a program can restore the list of tags by calling the PISDK.GetPoint method passing each of the strings returned from the ListSignups call. These tags can be used to build a Pointlist object  and its EventPipe property can deliver a new EventPipe used to to monitor their values.

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
pseLISTSIGNUPINTERNAL Internal SDK error.
pseCONSUMERNOTFOUND Consumer for the event pipe cannot be not found.
pseCONSUMERINIT The consumer was not properly initialized.
pseLISTSIGNUP Error listing signup information. See error.description for more details.
pseDISCONNECTEDOBJECT Event Pipe is no long connected to the server.

Enabling Operational Intelligence