[#BloombergLP-bslfmt-FormatterTestUtil-06-testEvaluateVFormat-08]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bslfmt.adoc[bslfmt]::xref:BloombergLP/bslfmt/FormatterTestUtil-06.adoc[FormatterTestUtil<wchar_t>]::testEvaluateVFormat
:relfileprefix: ../../../
:mrdocs:

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

== Synopsis

Declared in `<bslfmt_formattertestutil.h>`

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

== Description

Compare the specified `expectedResult` with the result of formatting the specified `value` 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 a standard library implementation. Optionally specify `arg`, `arg1` and `arg2` to be passed to the formatter as additional arguments. 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` can be determined at runtime.

== 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.
| *value*
| Primary value to format.
|===


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