AF SDK Reference

PIServer.Connect Method (Boolean)

Save PDF

TABLE OF CONTENTS

PIServer.Connect Method (Boolean)

Save PDF

Last UpdatedNov 18, 2025
3 minute read

Open a connection to the PI Data Archive using default credentials 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(
	bool force = false
)

Public Sub Connect ( 
	Optional force As Boolean = false
)

Dim instance As PIServer
Dim force As Boolean

instance.Connect(force)

public:
void Connect(
	bool force = false
)

member Connect : 
        ?force : bool 
(* Defaults:
        let _force = defaultArg force false
*)
-> unit

Parameters

force (Optional): Type: SystemBoolean
Indicates if the AF SDK should force a connection attempt even if the previous attempt failed. If , AF SDK will maintain the failed connection status for a default time period of 60 seconds.

Exceptions

Exception	Condition
PIConnectionException	A connection to the PI Data Archive server cannot be made.

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.

AF SDK Reference