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

Dumps the records of a wallet database to a human‐readable file.

== Synopsis

Declared in `<wallet/dump.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
bool
DumpWallet(
    xref:ArgsManager.adoc[ArgsManager] const& args,
    xref:wallet/WalletDatabase.adoc[WalletDatabase]& db,
    xref:bilingual_str.adoc[bilingual_str]& error);
----

== Return Value

true if the wallet was dumped successfully.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *args*
| The parsed arguments specifying the dump file and options.
| *db*
| The wallet database to read records from.
| *error*
| Receives an error message on failure.
|===


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