AF SDK Reference

PIAuthenticationException Constructor

Save PDF

PIAuthenticationException Constructor

Save PDF

Last UpdatedNov 18, 2025
3 minute read

Initializes a new instance of the PIAuthenticationException class with a specified error message and a reference to the inner exception that is the cause of this exception.

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

Syntax

public PIAuthenticationException(
	PIServer piServer,
	string message,
	int statusCode,
	IDictionary<PIAuthenticationOption, PIConnectionResult> reason,
	Exception innerException = null
)

Public Sub New ( 
	piServer As PIServer,
	message As String,
	statusCode As Integer,
	reason As IDictionary(Of PIAuthenticationOption, PIConnectionResult),
	Optional innerException As Exception = Nothing
)

Dim piServer As PIServer
Dim message As String
Dim statusCode As Integer
Dim reason As IDictionary(Of PIAuthenticationOption, PIConnectionResult)
Dim innerException As Exception

Dim instance As New PIAuthenticationException(piServer, 
	message, statusCode, reason, innerException)

public:
PIAuthenticationException(
	PIServer^ piServer, 
	String^ message, 
	int statusCode, 
	IDictionary<PIAuthenticationOption, PIConnectionResult>^ reason, 
	Exception^ innerException = nullptr
)

new : 
        piServer : PIServer * 
        message : string * 
        statusCode : int * 
        reason : IDictionary<PIAuthenticationOption, PIConnectionResult> * 
        ?innerException : Exception 
(* Defaults:
        let _innerException = defaultArg innerException null
*)
-> PIAuthenticationException

Parameters

piServer: Type: OSIsoft.AF.PIPIServer
The PIServer associated with the exception.
message: Type: SystemString
The error message that explains the reason for the exception.
statusCode: Type: SystemInt32
The status code indicating the cause of the current exception that was returned from the PIServer.
reason: Type: System.Collections.GenericIDictionaryPIAuthenticationOption, PIConnectionResult
The information for why the authentication failed when connecting to the PIServer.
innerException (Optional): Type: SystemException
The exception that is the cause of the current exception, or if no inner exception is specified.

Remarks

This exception can be thrown when there is an authentication error when establishing a connection to the PIServer. An exception that is thrown as a direct result of a previous exception should include a reference to the previous exception in the InnerException property.

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