Fluent Assertions Documentation
FluentAssertions Assembly / FluentAssertions Namespace / ExceptionAssertionsExtensions Class / WithMessage<TException> Method
The FluentAssertions.Specialized.ExceptionAssertions<TException> containing the thrown exception.
The wildcard pattern with which the exception message is matched, where * and ? have special meanings.
A formatted phrase as is supported by System.String.Format(System.String,System.Object[]) explaining why the assertion is needed. If the phrase does not start with the word because, it is prepended automatically.
Zero or more objects to format using the placeholders in because.
In This Topic
    WithMessage<TException> Method (ExceptionAssertionsExtensions)
    In This Topic
    Asserts that the thrown exception has a message that matches expectedWildcardPattern.
    Syntax
    [AsyncStateMachine(FluentAssertions.ExceptionAssertionsExtensions/d__0`1)] 
    [DebuggerStepThrough()] 
    [Extension()] 
    public static Task<ExceptionAssertions<TException>> WithMessage<TException>( 
       Task<ExceptionAssertions<TException>> task, 
       string expectedWildcardPattern, 
       string because, 
       params object[] becauseArgs 
    ) 
    where TException: Exception

    Parameters

    task
    The FluentAssertions.Specialized.ExceptionAssertions<TException> containing the thrown exception.
    expectedWildcardPattern
    The wildcard pattern with which the exception message is matched, where * and ? have special meanings.
    because
    A formatted phrase as is supported by System.String.Format(System.String,System.Object[]) explaining why the assertion is needed. If the phrase does not start with the word because, it is prepended automatically.
    becauseArgs
    Zero or more objects to format using the placeholders in because.

    Type Parameters

    TException
    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Standard: netstandard2.0, netstandard2.1.

    .NET Framework: net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also