Table of contents
TOC
Collapse the table of content
Expand the table of content

Patterns.VarSet Active Pattern (F#)

Den Delimarsky|Last Updated: 8/18/2017
|
1 Contributor

Recognizes expressions that represent setting a mutable variable that is in a local scope.

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

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

Syntax

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

Parameters

input Type: Expr

The input expression to match against.

Return Value

The formal return type is (Var * Expr) option. The option indicates whether there is a match. In a pattern matching expression, the input is decomposed into a tuple of two elements. The first element is a Var object that represents the mutable variable, and the second element is an expression that represents the right side of the assignment expression.

Remarks

This function is named VarSetPattern 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 8, Windows 7, Windows Server 2012, Windows Server 2008 R2

Version Information

F# Core Library Versions

Supported in: 2.0, 4.0, Portable

See Also

Quotations.Patterns Module (F#)

Microsoft.FSharp.Quotations Namespace (F#)

© 2017 Microsoft