[#BloombergLP-bdlt-FormatTestUtil-testFormatArg]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdlt.adoc[bdlt]::xref:BloombergLP/bdlt/FormatTestUtil.adoc[FormatTestUtil]::testFormatArg
:relfileprefix: ../../../
:mrdocs:

Compare `bsl::format` output of `value` and `arg` to an expected string.

== Synopsis

Declared in `<bdlt_formattestutil.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class t_VALUE_TYPE,
    class t_ARG_TYPE>
static
bool
testFormatArg(
    xref:bsl/string.adoc[bsl::string]* message,
    std::string_view const& exp,
    std::string_view const& format,
    t_VALUE_TYPE const& value,
    t_ARG_TYPE const& arg);
----

== Description

Compare the specified `exp` to the string result of calling `bsl::format` with the specified `format`, `value`, and `arg`, and return `true` if they match and `false` otherwise. If they do not match, load into the specified `message` a value describing the inputs and result of the failed test. Perform these tests for both `char`‐based and `wchar_t`‐based strings.

== Return Value

`true` if the formatted result matches `exp`, and `false` otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *message*
| loaded with a failure description when the comparison fails
| *exp*
| expected formatted result
| *format*
| format string passed to `bsl::format`
| *value*
| value to format
| *arg*
| additional argument passed to `bsl::format`
|===


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