AF SDK Reference

PISystem.Supports Method (String, Boolean)

Save PDF

TABLE OF CONTENTS

PISystem.Supports Method (String, Boolean)

Save PDF

Last UpdatedNov 18, 2025
2 minute read

Checks if the specified feature is supported by the PISystem.

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

Syntax

public bool Supports(
	string featureName,
	bool throwOnError = false
)

Public Function Supports ( 
	featureName As String,
	Optional throwOnError As Boolean = false
) As Boolean

Dim instance As PISystem
Dim featureName As String
Dim throwOnError As Boolean
Dim returnValue As Boolean

returnValue = instance.Supports(featureName, 
	throwOnError)

public:
bool Supports(
	String^ featureName, 
	bool throwOnError = false
)

member Supports : 
        featureName : string * 
        ?throwOnError : bool 
(* Defaults:
        let _throwOnError = defaultArg throwOnError false
*)
-> bool

Parameters

featureName: Type: SystemString
The name of the feature to check if it is supported by the PISystem.
throwOnError (Optional): Type: SystemBoolean
If , then an exception will be thrown if the specified feature is not supported.

Return Value

Type: Boolean
Returns if the server supports the specified featureName.

Exceptions

Exception	Condition
NotSupportedException	This exception is thrown if the feature is not supported and the throwOnError parameter is

Remarks

The named features that are supported by the PISystem are determined by what the server reports that it supports. These features are normally only supported while a feature is under development. Once it is released and all checks for the feature have been removed from the code, the feature is removed.

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

AF SDK Reference