Proficy Historian Client Access API
Proficy.Historian.ClientAccess.API Namespace / IData Interface
Methods Events

In This Topic
    IData Interface Members
    In This Topic

    The following tables list the members exposed by IData.

    Public Methods
     NameDescription
     MethodWrite a set of data values to a Historian server. Data writes may be optionally flagged with errorOnReplace=true to protect against replacing previously stored values.

    The chief constraint on number of samples supported in a single write is ConnectionProperties.MaxReceivedMessageSize. This determines the maximum size of a single message transmitted to a Historian server. This parameter must be matched on both client and server.

     
     MethodOverloaded.  Add a text comment record for a tag in a Historian server.  
     Method Delete tag data at the specified intervals in a Historian Server  
     Method Drop all previously established data subscriptions.  
     MethodRetrieve tag data from a Historian server matching the supplied data criteria.

    For large servers clients can optionally rely on large message sizes or result-paging or a combination of both to retrieve large numbers of data samples. Maximum message size is straight-forward and controlled by ConnectionProperties.MaxReceivedMessageSize - it must be matched on both client and server.

    Result-paging enables large result sets to be retrieved across multiple server requests with timing and size controlled by the client. The number of results retrieved per request is controlled via the query's PageSize property. To utilize result-paging, specify a non-zero PageSize and continue calling the same query while the return code is true to retrieve all results from a server. To protect the server and limit excessive server-memory utilization initiating a second query without first retrieving all results for a first query generates a fault.

     
     MethodSubscribe to data updates for a specific tag. Fires %% with details of the data update.  
     Method Unsubscribe to data updates for a specific tag.  
    Top
    Public Events
     NameDescription
     Event Occurs in response to data subscriptions when the latest tag value has been updated.  
    Top
    See Also