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

In This Topic
    IMessages Interface Members
    In This Topic

    The following tables list the members exposed by IMessages.

    Public Methods
     NameDescription
     Method Adds a new audit message to a Historian server.  
     Method Drops all previously established message subscriptions.  
     MethodRetrieve a list of audit messages from a Historian server matching the supplied message criteria.

    For large servers clients can optionally rely on large network-message sizes or result-paging or a combination of both to retrieve a large number of messages. Maximum network-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 new messages for a specific topic. Fires %% with the new message added.  
     Method Unsubscribe to new messages for a specific topic.  
    Top
    Public Events
     NameDescription
     Event Occurs in response to message subscriptions when a new message has been generated.  
    Top
    See Also