[#CreateUTXOSnapshot]
= CreateUTXOSnapshot
:mrdocs:

Helper to create UTXO snapshots given a chainstate and a file handle.

== Synopsis

Declared in `<rpc/blockchain.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
xref:UniValue.adoc[UniValue]
CreateUTXOSnapshot(
    xref:node/NodeContext.adoc[node::NodeContext]& node,
    xref:Chainstate.adoc[Chainstate]& chainstate,
    xref:AutoFile.adoc[AutoFile]&& afile,
    xref:fs/path.adoc[fs::path] const& path,
    xref:fs/path.adoc[fs::path] const& tmppath);
----

== Return Value

a UniValue map containing metadata about the snapshot.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *node*
| The node context.
| *chainstate*
| The chainstate to snapshot.
| *afile*
| The output file to write the snapshot to.
| *path*
| The final path for the snapshot file.
| *tmppath*
| The temporary path written to before renaming to `path.`
|===


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