[#wallet-PurposeFromString]
= xref:wallet.adoc[wallet]::PurposeFromString
:relfileprefix: ../
:mrdocs:

Parse an address purpose from its serialized string form.

== Synopsis

Declared in `<wallet/wallet.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
std::optional<AddressPurpose>
PurposeFromString(std::string_view s);
----

== Return Value

The parsed purpose, or nullopt if unrecognized.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *s*
| The string name to parse.
|===


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