[#BloombergLP-bdls-PathUtil-getRoot-0a]
= xref:BloombergLP.adoc[BloombergLP]::xref:BloombergLP/bdls.adoc[bdls]::xref:BloombergLP/bdls/PathUtil.adoc[PathUtil]::getRoot
:relfileprefix: ../../../
:mrdocs:

Load the root portion of a path&period;

== Synopsis

Declared in `&lt;bdls&lowbar;pathutil&period;h&gt;`

[source,cpp,subs="verbatim,replacements,macros,-callouts"]
----
static
int
getRoot(
    xref:bsl/string.adoc[bsl::string]* root,
    std::string&lowbar;view const& path,
    int rootEnd = &hyphen;1);
----

== Description

If the optionally specified `rootEnd` offset is non&hyphen;negative, it is taken as the position in `path` of the character following the root&period; Return 0 on success, and a non&hyphen;zero value otherwise&semi; in particular, return a nonzero value if `path` is relative&period; Note that the meaning of the root part is platform&hyphen;dependent&period; See &lsqb;&rsqb;and Performance)&period; See also  for the definition of root&period;

== Return Value

0 on success, and a non&hyphen;zero value otherwise

== Parameters

[cols="1,4"]
|===
| Name| Description
| *root*
| receives the root portion of `path`
| *path*
| filesystem path to examine
| *rootEnd*
| if non&hyphen;negative, position in `path` of the character following the root
|===


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