[#HelpMessageOpt]
= HelpMessageOpt
:mrdocs:

Format a string to be used as option description in help messages

== Synopsis

Declared in `&lt;common&sol;args&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
std::string
HelpMessageOpt(
    std::string&lowbar;view option,
    std::string&lowbar;view help&lowbar;param,
    std::string&lowbar;view message,
    bool subopt = false);
----

== Return Value

the formatted string

== Parameters

[cols="1,4"]
|===
| Name| Description
| *option*
| Option name (e&period;g&period; &quot;&hyphen;rpcuser&quot;)
| *help&lowbar;param*
| Help parameter (e&period;g&period; &quot;&equals;&lt;user&gt;&quot; or &quot;&quot;)
| *message*
| Option description (e&period;g&period; &quot;Username for JSON&hyphen;RPC connections&quot;)
| *subopt*
| True if this is a suboption, instead of a top&hyphen;level option&period;
|===


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