[#boost-urls-decode-01]
= xref:boost.adoc[boost]::xref:boost/urls.adoc[urls]::decode
:relfileprefix: ../../
:mrdocs:

`decode` overloads

== Synopses

Declared in `<https://www.github.com/boostorg/url/blob/develop/include/boost/url/decode.hpp#Lundefined[boost/url/decode.hpp]>`

Return a percent‐decoded string


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
template<xref:boost/urls/string_token/StringToken.adoc[string_token::StringToken] StringToken = xref:boost/urls/string_token/return_string.adoc[string_token::return_string]>
system::result<StringToken::result_type>
xref:boost/urls/decode-07.adoc[decode](
    core::string_view s,
    xref:boost/urls/encoding_opts.adoc[encoding_opts] opt = {},
    StringToken&& token = {}) noexcept;
----

[.small]#xref:boost/urls/decode-07.adoc[_» more..._]#

Apply percent‐decoding to an arbitrary string


[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
system::result<std::size_t>
xref:boost/urls/decode-03.adoc[decode](
    char* dest,
    std::size_t size,
    core::string_view s,
    xref:boost/urls/encoding_opts.adoc[encoding_opts] opt = {}) noexcept;
----

[.small]#xref:boost/urls/decode-03.adoc[_» more..._]#

== Return Value

* A result containing the decoded string in the format described by the passed string token.
* The number of characters written to the destination buffer, or an error.

== Parameters

[cols="1,4"]
|===
|Name|Description

| *s*
| The string to decode.
| *opt*
| The decoding options. If omitted, the default options are used.
| *token*
| A string token.
| *dest*
| The destination buffer to write to.
| *size*
| The number of writable characters pointed to by `dest`. If this is less than the decoded size, the result is truncated.
|===

== See Also

xref:boost/urls/decode-07.adoc[`decode`], xref:boost/urls/decoded_size.adoc[`decoded_size`], xref:boost/urls/encoding_opts.adoc[`encoding_opts`], xref:boost/urls/string_token/return_string.adoc[`string_token::return_string`].

xref:boost/urls/decoded_size.adoc[`decoded_size`], xref:boost/urls/encoding_opts.adoc[`encoding_opts`], xref:boost/urls/make_pct_string_view.adoc[`make_pct_string_view`].


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