AF SDK Reference

PIAuthenticationException.Reason Property

Save PDF

TABLE OF CONTENTS

PIAuthenticationException.Reason Property

Save PDF

Last UpdatedNov 18, 2025
2 minute read

The information for why the authentication failed when connecting to the PIServer.

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

Syntax

public IDictionary<PIAuthenticationOption, PIConnectionResult> Reason { get; }

Public ReadOnly Property Reason As IDictionary(Of PIAuthenticationOption, PIConnectionResult)
	Get

Dim instance As PIAuthenticationException
Dim value As IDictionary(Of PIAuthenticationOption, PIConnectionResult)

value = instance.Reason

public:
property IDictionary<PIAuthenticationOption, PIConnectionResult>^ Reason {
	IDictionary<PIAuthenticationOption, PIConnectionResult>^ get ();
}

member Reason : IDictionary<PIAuthenticationOption, PIConnectionResult> with get

Property Value

Type: IDictionaryPIAuthenticationOption, PIConnectionResult
Returns the information for why the authentication failed when connecting to the PIServer.

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