[#FormatSubVersion]
= FormatSubVersion
:mrdocs:

Formats a BIP14&hyphen;style user agent subversion string&period;

== Synopsis

Declared in `&lt;clientversion&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
std::string
FormatSubVersion(
    std::string const& name,
    int nClientVersion,
    std::vector&lt;std::string&gt; const& comments);
----

== Return Value

The formatted subversion string&period;

== Parameters

[cols="1,4"]
|===
| Name| Description
| *name*
| The client name to embed in the user agent&period;
| *nClientVersion*
| The numeric client version to embed&period;
| *comments*
| Optional comments appended in parentheses&period;
|===


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