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

AF SDK Reference

AFGlobalSettings.CheckPIVersion Property

  • Last UpdatedNov 18, 2025
  • 2 minute read
AFGlobalSettings.CheckPIVersion Property
Indicates if the version of the PIServer should be checked when making a connection to the server.

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

Syntax

public static bool CheckPIVersion { get; set; }
Public Shared Property CheckPIVersion As Boolean
	Get
	Set

Dim value As Boolean

value = AFGlobalSettings.CheckPIVersion

AFGlobalSettings.CheckPIVersion = value
public:
static property bool CheckPIVersion {
	bool get ();
	void set (bool value);
}
static member CheckPIVersion : bool with get, set

Property Value

Type: Boolean
Returns if the version of the PIServer should be checked when making a connection to the server. Set to to disable this check. The default value is .

Remarks

When enabled, the version of the PIServer will be checked when a connection is made to determine if it is support. If the version of the PIServer is allowed to connect but is not fully supported, then a warning will be generated. If the version of the PIServer is not supported, then an error will be thrown.

The default value for this property is read from the SDK's configuration file in the OSI directory under the CommonApplicationData directory. This default value will be the default for all clients executed on the computer. If this property is modified in the client, then it will only affect the current client and the modified value will not be persisted.

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

See Also

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