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

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)

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

// Usage:
failwithf format

format

Type: StringFormat<'T,'Result>

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.

The following code example illustrates the use of failwithf.

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

Windows 8, Windows 7, Windows Server 2012, Windows Server 2008 R2

F# Core Library Versions

Supported in: 2.0, 4.0, Portable

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft