[#BloombergLP-bslfmt-FormatterTestUtil-05-testEvaluateVFormat-0f]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslfmt.adoc[bslfmt]::xref:BloombergLP/bslfmt/FormatterTestUtil-05.adoc[FormatterTestUtil<char>]::testEvaluateVFormat
:relfileprefix: ../../../
:mrdocs:

Compare formatting of `value`, `arg1`, and `arg2` against `expectedResult` via `vformat`.

== Synopsis

Declared in `<bslfmt_formattertestutil.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class t_TYPE,
    class t_ARG_1,
    class t_ARG_2>
static
bool
testEvaluateVFormat(
    xref:bsl/string.adoc[bsl::string]* message,
    bsl::basic_string_view<char> expectedResult,
    bool alsoTestOracle,
    bsl::basic_string_view<char> fmt,
    t_TYPE&& value,
    t_ARG_1&& arg1,
    t_ARG_2&& arg2);
----

== Description

Compare the specified `expectedResult` with the result of formatting the specified `value`, `arg1`, and `arg2` with the specified `fmt` obtained using a `bslfmt::formatter` specialization for the (template parameter) `t_TYPE`. If the specified `alsoTestOracle` is `true`, also compare the `expectedResult` with the result of formatting obtained using standard library implementation. Return `true` if these strings are equal, otherwise store a description of the error in the specified output `message` and return `false`. Note that `fmt` is *NOT* required to be a compile time constant expression.

== Return Value

`true` if formatting matches `expectedResult`, else `false`.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *message*
| Output parameter for an error description on failure.
| *expectedResult*
| Expected formatted output string.
| *alsoTestOracle*
| If `true`, also compare against the standard library formatter.
| *fmt*
| Runtime format string (two additional arguments).
| *value*
| Primary value to format.
| *arg1*
| First additional format argument.
| *arg2*
| Second additional format argument.
|===


[.small]#Created with https://www.mrdocs.com[MrDocs]#