[#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.

== Synopsis

Declared in `<bdls_pathutil.h>`

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

== Description

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

== Return Value

0 on success, and a non‐zero value otherwise

== Parameters

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


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