Patterns.WhileLoop Active Pattern (F#)

  • Article

Recognizes expressions that represent while loops.

Namespace/Module Path: Microsoft.FSharp.Quotations.Patterns

Assembly: FSharp.Core (in FSharp.Core.dll)

// Signature:
( |WhileLoop|_| ) : (input:Expr) -> (Expr * Expr) option

Parameters

  • input
    Type: Expr

    The input expression to match against.

Return Value

The formal return type is (Expr * Expr) option. The option value indicates whether there is a match. In a pattern matching expression, the input is decomposed, upon a successful match, into a tuple of expressions. The first element of the tuple is the test expression and the second is the body of the loop.

Remarks

This function is named WhileLoopPattern in the .NET Framework assembly. If you are accessing the member from a .NET Framework language other than F#, or through reflection, use this name.

Platforms

Windows 7, Windows Vista SP2, Windows XP SP3, Windows XP x64 SP2, Windows Server 2008 R2, Windows Server 2008 SP2, Windows Server 2003 SP2

Version Information

F# Runtime

Supported in: 2.0, 4.0

Silverlight

Supported in: 3

See Also

Reference

Quotations.Patterns Module (F#)

Microsoft.FSharp.Quotations Namespace (F#)