[#BloombergLP-bslfmt-FormatterTestUtil-05-testEvaluateFormat-01]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslfmt.adoc[bslfmt]::xref:BloombergLP/bslfmt/FormatterTestUtil-05.adoc[FormatterTestUtil<char>]::testEvaluateFormat
:relfileprefix: ../../../
:mrdocs:

`testEvaluateFormat` overloads

== Synopses

Declared in `<bslfmt_formattertestutil.h>`

Compare `expectedResult` with formatting `value` via `format`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<class t_TYPE>
static
bool
xref:BloombergLP/bslfmt/FormatterTestUtil-05/testEvaluateFormat-00.adoc[testEvaluateFormat](
    xref:bsl/string.adoc[bsl::string]* message,
    bsl::basic_string_view<char> expectedResult,
    bool alsoTestOracle,
    std::format_string<t_TYPE> fmt,
    t_TYPE&& value);
----

[.small]#xref:BloombergLP/bslfmt/FormatterTestUtil-05/testEvaluateFormat-00.adoc[_» more..._]#

Compare formatting of `value` and `arg` against `expectedResult`.


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class t_TYPE,
    class t_ARG>
static
bool
xref:BloombergLP/bslfmt/FormatterTestUtil-05/testEvaluateFormat-06.adoc[testEvaluateFormat](
    xref:bsl/string.adoc[bsl::string]* message,
    bsl::basic_string_view<char> expectedResult,
    bool alsoTestOracle,
    std::format_string<t_TYPE, t_ARG> fmt,
    t_TYPE&& value,
    t_ARG&& arg);
----

[.small]#xref:BloombergLP/bslfmt/FormatterTestUtil-05/testEvaluateFormat-06.adoc[_» more..._]#

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


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

[.small]#xref:BloombergLP/bslfmt/FormatterTestUtil-05/testEvaluateFormat-0c.adoc[_» more..._]#

== 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*
| Compile‐time format string.
| *value*
| Primary value to format.
| *arg*
| Additional format argument.
| *arg1*
| First additional format argument.
| *arg2*
| Second additional format argument.
|===


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