AF SDK Reference

PIServer.Connect Method (NetworkCredential, AFConnectionPreference, PIAuthenticationMode)

Save PDF

PIServer.Connect Method (NetworkCredential, AFConnectionPreference, PIAuthenticationMode)

Save PDF

Last UpdatedNov 18, 2025
3 minute read

Open a connection to the PI Data Archive using the specified credentials and connection preference to allow sending and retrieving data.

Namespace: OSIsoft.AF.PI
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182

Syntax

public void Connect(
	NetworkCredential credential,
	AFConnectionPreference preference,
	PIAuthenticationMode authenticationMode
)

Public Sub Connect ( 
	credential As NetworkCredential,
	preference As AFConnectionPreference,
	authenticationMode As PIAuthenticationMode
)

Dim instance As PIServer
Dim credential As NetworkCredential
Dim preference As AFConnectionPreference
Dim authenticationMode As PIAuthenticationMode

instance.Connect(credential, preference, 
	authenticationMode)

public:
void Connect(
	NetworkCredential^ credential, 
	AFConnectionPreference preference, 
	PIAuthenticationMode authenticationMode
)

member Connect : 
        credential : NetworkCredential * 
        preference : AFConnectionPreference * 
        authenticationMode : PIAuthenticationMode -> unit

Parameters

credential: Type: System.NetNetworkCredential
The NetworkCredential to use when connecting to the server.
preference: Type: OSIsoft.AFAFConnectionPreference
The connection preference to use when determining which member of the PICollective is selected for the connection. The default preference can be obtained from Preference property of the this object's ConnectionInfo. The Preference setting will be updated to this value after a successful connection.
authenticationMode: Type: OSIsoft.AF.PIPIAuthenticationMode
Specifies the type of authentication to be used when making the connection. The specified credential must match the type of authentication.

Exceptions

Exception	Condition
PIConnectionException	A connection to the PI Data Archive server cannot be made.
PIVersionNotSupportedException	This exception will be generated when attempting to connect to a PIServer with using WindowsAuthentication and the server does not support this mode of authentication.

Remarks

If an application accesses a property or invokes a method that requires server access, an implicit connection is performed. When a connection is no longer needed, it can be closed using the Disconnect method.

Examples

// Get the PIServers collection for the current user and default PIServer.
PIServer myPIServer = new PIServers().DefaultPIServer;

// Simple connect.
myPIServer.Connect();
myPIServer.Disconnect();


// Connect and display a credential prompt dialog if current user login fails.
// Only available in .Net Framework AFSDK
// myPIServer.Connect(true, null);
// myPIServer.Disconnect();

try
{
    // Connect using a specified credential.
    NetworkCredential credential = new NetworkCredential("guest", String.Empty);
    myPIServer.Connect(credential);
}
catch (Exception ex)
{
    // Expected exception since credential needs a valid user name and password.
    Console.WriteLine(ex.Message);
}

' Get the PIServers collection for the current user and default PIServer.
Dim myPIServer As PIServer = New PIServers().DefaultPIServer

' Simple connect.
myPIServer.Connect()
myPIServer.Disconnect()

' Connect and display a credential prompt dialog if current user login fails.
' Only available in .Net Framework AFSDK
' myPIServer.Connect(True, Nothing)
' myPIServer.Disconnect()

Try
    ' Connect using a specified credential.
    Dim credential As NetworkCredential = New NetworkCredential("guest", String.Empty)
    myPIServer.Connect(credential)
Catch ex As Exception
    ' Expected exception since credential needs a valid user name and password.
    Console.WriteLine(ex.Message)
End Try

No code example is currently available or this language may not be supported.

Version Information

AFSDK

Supported in: 3.1.1, 3.1.0, 3.0.2, 3.0.1, 3.0.0, 2.10.11, 2.10.5, 2.10.0, 2.10, 2.9.5, 2.9, 2.8.5, 2.8, 2.7.5, 2.7, 2.6

AF SDK Reference