[#bech32-Decode]
= xref:bech32.adoc[bech32]::Decode
:relfileprefix: ../
:mrdocs:

Decode a Bech32 or Bech32m string.

== Synopsis

Declared in `<bech32.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:bech32/DecodeResult.adoc[DecodeResult]
Decode(
    std::string const& str,
    xref:bech32/CharLimit.adoc[CharLimit] limit = CharLimit::BECH32);
----

== Return Value

The decode result; its encoding is Encoding::INVALID on failure.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *str*
| The string to decode.
| *limit*
| The maximum accepted string length.
|===


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