[#bsl-quoted-03]
= xref:bsl.adoc[bsl]::quoted
:relfileprefix: ../
:mrdocs:

Return a streamable object that quotes the specified `value`.

== Synopsis

Declared in `<bslstl_iomanip.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<
    class t_CHAR_TYPE,
    class t_CHAR_TRAITS,
    class t_ALLOC>
decltype(auto)
quoted(
    xref:bsl/basic_string-0faf.adoc[bsl::basic_string<t_CHAR_TYPE, t_CHAR_TRAITS, t_ALLOC>] const& value,
    t_CHAR_TYPE delim = t_CHAR_TYPE('"'),
    t_CHAR_TYPE escape = t_CHAR_TYPE('\\'));
----

== Description

The returned object contains a quoted version of the specified `value` obtained using the optionally specified `delim` and `escape` characters, and can be inserted into an output stream.

== Return Value

streamable object that quotes `value` for insertion into a stream

== Parameters

[cols="1,4"]
|===
| Name| Description
| *value*
| string to quote
| *delim*
| delimiter character surrounding the quoted string
| *escape*
| escape character used within the quoted string
|===


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