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

ExtraTopLevelOperators.failwithf<'T,'Result> Function (F#)

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

Print to a string buffer and raise an exception with the given result. Helper printers must return strings.

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

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

Syntax

// Signature:
failwithf : StringFormat<'T,'Result> -> 'T

// Usage:
failwithf format

Parameters

format Type: StringFormat<'T,'Result>

Remarks

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

Example


let reportError componentName code =
    failwithf "Component %s reported a failure. Error code: 0x%x" componentName code
reportError "Filesystem monitor" 0x80000005

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

Core.ExtraTopLevelOperators Module (F#)

Microsoft.FSharp.Core Namespace (F#)

© 2017 Microsoft