Option.get<'T> Function (F#)

  • Article

Gets the value associated with the option.

Namespace/Module Path: Microsoft.FSharp.Core.Option

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

// Signature:
get : 'T option -> 'T

// Usage:
get option

Parameters

  • option
    Type: 'Toption

    The input option.

Exceptions

Exception

Condition

ArgumentException

Thrown when the option is None.

Return Value

The value within the option.

Remarks

This function is named GetValue in compiled assemblies. If you are accessing the function from a language other than F#, or through reflection, use this name.

Example

The following code illustrates the use of Option.get.

let printOption opt =
    if (Option.isSome opt) then
        printfn "%A" <| Option.get opt
    else ()
printOption (Some(1))
printOption (Some("xyz"))
printOption (None)
printOption (Some(1.0))

Output

1
"xyz"
1.0

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

Reference

Core.Option Module (F#)

Microsoft.FSharp.Core Namespace (F#)