AFAnalysis.SetStatus Method (IList(AFAnalysis), AFStatus)
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Set the list of analyses to the specified status.
Namespace: OSIsoft.AF.Analysis
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public static void SetStatus( IList<AFAnalysis> analyses, AFStatus status )
Public Shared Sub SetStatus ( analyses As IList(Of AFAnalysis), status As AFStatus ) Dim analyses As IList(Of AFAnalysis) Dim status As AFStatus AFAnalysis.SetStatus(analyses, status)
public: static void SetStatus( IList<AFAnalysis^>^ analyses, AFStatus status )
static member SetStatus : analyses : IList<AFAnalysis> * status : AFStatus -> unit
Parameters
- analyses
- Type: System.Collections.GenericIListAFAnalysis
The list of analyses to have their Status set to the specified status value. - status
- Type: OSIsoft.AF.AnalysisAFStatus
The new AFStatus for the analyses.
Exceptions
| Exception | Condition |
|---|---|
| SecurityException | This exception is thrown when the user does not have Write permission on one of the analyses in the specified list. |
| ArgumentException | This exception can be thrown if one of the items in the analyses list has been deleted. |
Remarks
This method will set all the analyses in the list to the same AFStatus in a single
call to the server. This is more efficient than setting the Status property of
each analysis.