String.iteri Function (F#)

Applies a specified function to each character and corresponding index in the string.

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

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

// Signature:
String.iteri : (int -> char -> unit) -> string -> unit

// Usage:
String.iteri action str

Parameters

  • action
    Type: int -> char -> unit

    The function to apply to each character and index of the string.

  • str
    Type: string

    The input string.

Exceptions

Exception

Condition

ArgumentNullException

Thrown when the input string is null.

Remarks

This function is named IterateIndexed 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 example shows how to use String.iteri.

let enumerateCharacters inputString = 
    String.iteri (fun i c -> printfn "%d %c" i c) inputString
enumerateCharacters "TIME"
enumerateCharacters "SPACE"

Output

0 T
1 I
2 M
3 E
0 S
1 P
2 A
3 C
4 E

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

Core.String Module (F#)

Microsoft.FSharp.Core Namespace (F#)