[#node-ReadMiningArgs]
= xref:node.adoc[node]::ReadMiningArgs
:relfileprefix: ../
:mrdocs:

Read the mining options set in `args.` Returns an error if one was encountered.

== Synopsis

Declared in `<node/mining_args.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
[[nodiscard]]
xref:util/Result.adoc[util::Result<BlockCreateOptions>]
ReadMiningArgs(xref:ArgsManager.adoc[ArgsManager] const& args);
----

== Return Value

The block‐creation options on success, or an error on failure.

[NOTE]
====
The return value https://en.cppreference.com/cpp/language/attributes/nodiscard[should not be discarded^].
====
== Parameters

[cols="1,4"]
|===
| Name| Description
| *args*
| Argument manager holding the parsed settings.
|===


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