AFAnalysisRule.Run Method
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
This method executes the analysis and generates analysis results.
Namespace: OSIsoft.AF.Analysis
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public virtual bool Run()
Public Overridable Function Run As Boolean Dim instance As AFAnalysisRule Dim returnValue As Boolean returnValue = instance.Run()
public: virtual bool Run()
abstract Run : unit -> bool override Run : unit -> bool
Return Value
Type: BooleanReturns if the operation was successful. Any messages generated during the analysis run process will be output using AFTrace.
Remarks
The default implementation of this method only checks the security rights.
The analysis rule should override this method and implement the logic
for running a case.
 Security Note |
|---|
| You must have Execute security rights to run a case. |