[#FormatSubVersion]
= FormatSubVersion
:mrdocs:

Formats a BIP14‐style user agent subversion string.

== Synopsis

Declared in `<clientversion.h>`

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

== Return Value

The formatted subversion string.

== Parameters

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


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