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

Check option values for validity. Returns an error for invalid values.

== Synopsis

Declared in `<node/mining_args.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
[[nodiscard]]
xref:util/Result.adoc[util::Result<void>]
CheckMiningOptions(
    xref:node/BlockCreateOptions.adoc[BlockCreateOptions] options,
    bool use_argnames);
----

== Return Value

An empty result if the options are valid, or an error otherwise.

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

[cols="1,4"]
|===
| Name| Description
| *options*
| The block‐creation options to validate.
| *use_argnames*
| Whether errors should name the command‐line arguments rather than the struct fields.
|===


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