Proficy Historian Client Access API
Proficy.Historian.ClientAccess.API Namespace / ICollectors Interface / Subscribe Method
A collector name.
Example



In This Topic
    Subscribe Method (ICollectors)
    In This Topic
    Subscribe to collector changes for a specific collector. Fires %% with details of the collector change.
    Syntax
    'Declaration
     
    Sub Subscribe( _
       ByVal collectorname As String _
    ) 
    'Usage
     
    Dim instance As ICollectors
    Dim collectorname As String
     
    instance.Subscribe(collectorname)
    void Subscribe( 
       string collectorname
    )
    void Subscribe( 
       String^ collectorname
    ) 

    Parameters

    collectorname
    A collector name.
    Example
    // establish event handler
    connection.CollectorChangedEvent += new CollectorChangedHandler(CollectorChanged);
                  
    // request collector subscriptions
    connection.ICollectors.Subscribe("Sample Collector Name");
    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also