Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AF SDK Reference

PIConnectionResult Enumeration

  • Last UpdatedNov 18, 2025
  • 2 minute read
PIConnectionResult Enumeration
Defines the results of a connection attempt to a PIServer.

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

Syntax

public enum PIConnectionResult
Public Enumeration PIConnectionResult

Dim instance As PIConnectionResult
public enum class PIConnectionResult
type PIConnectionResult

Members

  Member nameValueDescription
Success0 Connection was successful using the authentication method.
Fail1 Connection failed using the authentication method.
NotAllowed2 The authentication method is not allowed for connecting to the PIServer.
NotTried3 The authentication method was not tried.
NotSupported-10008 The PIServer does not support the authentication method.

Remarks

This enumeration is used by the PIAuthenticationException when a connection attempt fails to a PIServer. The exception's Reason will provide the reason for the failure.

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

See Also

In This Topic
Related Links
TitleResults for “How to create a CRG?”Also Available in