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

Load an existing wallet from disk into the context.

== Synopsis

Declared in `<wallet/wallet.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
std::shared_ptr<CWallet>
LoadWallet(
    xref:wallet/WalletContext.adoc[WalletContext]& context,
    std::string const& name,
    std::optional<bool> load_on_start,
    xref:wallet/DatabaseOptions.adoc[DatabaseOptions] const& options,
    xref:wallet/DatabaseStatus.adoc[DatabaseStatus]& status,
    xref:bilingual_str.adoc[bilingual_str]& error,
    std::vector<bilingual_str>& warnings);
----

== Return Value

The loaded wallet, or nullptr on failure.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *context*
| The wallet context to load into.
| *name*
| The wallet name to load.
| *load_on_start*
| Optionally set whether the wallet loads on startup.
| *options*
| Database options used to open the wallet.
| *status*
| Set to the database open status.
| *error*
| Set to an error message on failure.
| *warnings*
| Warnings produced while loading.
|===


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