AFAnalysisService.CanQueueCalculation Method
- Last UpdatedNov 18, 2025
- 2 minute read
- PI System
- AF SDK 2024 R2
- Developer
Test if the queuing calculation option is available.
Namespace: OSIsoft.AF.Analysis
Assembly: OSIsoft.AFSDK (in OSIsoft.AFSDK.dll) Version: 3.1.1.1182
Syntax
public bool CanQueueCalculation( out string reason )
Public Function CanQueueCalculation ( <OutAttribute> ByRef reason As String ) As Boolean Dim instance As AFAnalysisService Dim reason As String Dim returnValue As Boolean returnValue = instance.CanQueueCalculation(reason)
public: bool CanQueueCalculation( [OutAttribute] String^% reason )
member CanQueueCalculation : reason : string byref -> bool
Parameters
- reason
- Type: SystemString
Reason why calculation operation cannot be queued.
Return Value
Type: BooleanReturns if calculation can be queued, otherwise.
Remarks
This method will test if queuing calculation option is available on this analysis service. If the queuing calculation option is not available, then the reason is given in the reason parameter.
 Security Note |
|---|
| You must have Execute security rights to queue a calculation. |