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

Check option values for validity&period; Returns an error for invalid values&period;

== Synopsis

Declared in `&lt;node&sol;mining&lowbar;args&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
&lsqb;&lsqb;nodiscard&rsqb;&rsqb;
xref:util/Result.adoc[util::Result&lt;void&gt;]
CheckMiningOptions(
    xref:node/BlockCreateOptions.adoc[BlockCreateOptions] options,
    bool use&lowbar;argnames);
----

== Return Value

An empty result if the options are valid, or an error otherwise&period;

[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&hyphen;creation options to validate&period;
| *use&lowbar;argnames*
| Whether errors should name the command&hyphen;line arguments rather than the struct fields&period;
|===


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