IWhileLoopOperation Interface

Definition

Namespace:

Microsoft.CodeAnalysis.Operations

Assembly:

Microsoft.CodeAnalysis.dll

Package:

Microsoft.CodeAnalysis.Common v4.9.2

Source:

Operations.Generated.cs

Represents a while or do while loop.

Current usage: (1) C# 'while' and 'do while' loop statements. (2) VB 'While', 'Do While' and 'Do Until' loop statements.

public interface class IWhileLoopOperation : Microsoft::CodeAnalysis::Operations::ILoopOperation

public interface IWhileLoopOperation : Microsoft.CodeAnalysis.Operations.ILoopOperation

type IWhileLoopOperation = interface
    interface ILoopOperation
    interface IOperation

Public Interface IWhileLoopOperation
Implements ILoopOperation

Implements

IOperation ILoopOperation

Remarks

This interface is reserved for implementation by its associated APIs. We reserve the right to change it in the future.

Properties

Body	Body of the loop. (Inherited from ILoopOperation)
ChildOperations	An enumerable of child operations for this operation. (Inherited from IOperation)
Children	Obsolete. An array of child operations for this operation. Deprecated: please use ChildOperations. (Inherited from IOperation)
Condition	Condition of the loop. This can only be null in error scenarios.
ConditionIsTop	True if the Condition is evaluated at start of each loop iteration. False if it is evaluated at the end of each loop iteration.
ConditionIsUntil	True if the loop has 'Until' loop semantics and the loop is executed while Condition is false.
ConstantValue	If the operation is an expression that evaluates to a constant value, HasValue is true and Value is the value of the expression. Otherwise, HasValue is false. (Inherited from IOperation)
ContinueLabel	Loop continue label. (Inherited from ILoopOperation)
ExitLabel	Loop exit/break label. (Inherited from ILoopOperation)
IgnoredCondition	Additional conditional supplied for loop in error cases, which is ignored by the compiler. For example, for VB 'Do While' or 'Do Until' loop with syntax errors where both the top and bottom conditions are provided. The top condition is preferred and exposed as Condition and the bottom condition is ignored and exposed by this property. This property should be null for all non-error cases.
IsImplicit	Set to True if compiler generated /implicitly computed by compiler code (Inherited from IOperation)
Kind	Identifies the kind of the operation. (Inherited from IOperation)
Language	The source language of the IOperation. Possible values are CSharp and VisualBasic. (Inherited from IOperation)
Locals	Declared locals. (Inherited from ILoopOperation)
LoopKind	Kind of the loop. (Inherited from ILoopOperation)
Parent	IOperation that has this operation as a child. Null for the root. (Inherited from IOperation)
SemanticModel	Optional semantic model that was used to generate this operation. Non-null for operations generated from source with GetOperation(SyntaxNode, CancellationToken) API and operation callbacks made to analyzers. Null for operations inside a ControlFlowGraph. (Inherited from IOperation)
Syntax	Syntax that was analyzed to produce the operation. (Inherited from IOperation)
Type	Result type of the operation, or null if the operation does not produce a result. (Inherited from IOperation)

Methods

Accept(OperationVisitor)	(Inherited from IOperation)
Accept<TArgument,TResult>(OperationVisitor<TArgument,TResult>, TArgument)	(Inherited from IOperation)

Extension Methods

Descendants(IOperation)	Returns all the descendant operations of the given operation in evaluation order.
DescendantsAndSelf(IOperation)	Returns all the descendant operations of the given operation including the given operation in evaluation order.