List.head<'T> Function (F#)

  • Article

Returns the first element of the list.

Namespace/Module Path: Microsoft.FSharp.Collections.List

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

// Signature:
List.head : 'T list -> 'T

// Usage:
List.head list

Parameters

  • list
    Type: 'Tlist

    The input list.

Exceptions

Exception

Condition

ArgumentException

Thrown when the list is empty.

Return Value

The first element of the list.

Remarks

Raises ArgumentException if list is empty

This function is named Head in compiled assemblies. If you are accessing the function from a 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

Reference

Collections.List Module (F#)

Microsoft.FSharp.Collections Namespace (F#)