ServerConnection Class

In This Topic

Encapsulates a client connection to a Historian server. Provides methods for interacting with a server for query, creation, configuration and maintenance of: data, tags, messages, collectors and archive files.

Object Model

Syntax

Visual Basic
C#
C++/CLI

'Declaration
 
Public Class ServerConnection 
   Implements IArchives, ICollectors, IData, IDataStores, IEnumeratedSets, IMessages, IPublish, IQueryModifiers, IServer, ITags, IUserDefinedTypes

'Usage
 
Dim instance As ServerConnection

public class ServerConnection : IArchives, ICollectors, IData, IDataStores, IEnumeratedSets, IMessages, IPublish, IQueryModifiers, IServer, ITags, IUserDefinedTypes

public ref class ServerConnection : public IArchives, ICollectors, IData, IDataStores, IEnumeratedSets, IMessages, IPublish, IQueryModifiers, IServer, ITags, IUserDefinedTypes

Example

// sample connection to a Historian server on local machine // current Windows user credentials are used for authorization ServerConnection connection = new ServerConnection(new ConnectionProperties { ServerCertificateValidationMode = CertificateValidationMode.None }); // establish a connection connection.Connect(); // output the local server-time Console.WriteLine("Server time is " + connection.IServer.GetCurrentServerTime().ToLocalTime()); // disconnect connection.Disconnect();

Inheritance Hierarchy

System.Object
Proficy.Historian.ClientAccess.API.ServerConnection

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

Reference

ServerConnection Members
Proficy.Historian.ClientAccess.API Namespace