[#FormatHDKeypath]
= FormatHDKeypath
:mrdocs:

Format an HD keypath as a string, prefixed with the master key marker "m".

== Synopsis

Declared in `<util/bip32.h>`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
std::string
FormatHDKeypath(
    std::vector<uint32_t> const& path,
    bool apostrophe = false);
----

== Return Value

The key path formatted as a string.

== Parameters

[cols="1,4"]
|===
| Name| Description
| *path*
| The derivation indices to format.
| *apostrophe*
| Use an apostrophe rather than 'h' to mark hardened steps.
|===


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