KernelBasePathCchStripToRoot Method
Removes all file and directory elements in a path except for the root information.
This function differs from
PathStripToRoot(StringBuilder) in that it accepts paths with "\", "\?" and "\?\UNC" prefixes.
Note: This function should be used in place of
PathStripToRoot(StringBuilder) to prevent the possibility of a buffer overrun.
Namespace: DevCase.Win32.NativeMethodsAssembly: DevCase.net48 (in DevCase.net48.dll) Version: 6.0.0.0 (6.0)
XMLNS for XAML: Not mapped to an xmlns.
[DllImportAttribute("KernelBase.dll", CharSet = CharSet.Auto, BestFitMapping = false,
ThrowOnUnmappableChar = true)]
public static HResult PathCchStripToRoot(
StringBuilder buffer,
uint bufferSize
)
<DllImportAttribute("KernelBase.dll", CharSet := CharSet.Auto, BestFitMapping := false,
ThrowOnUnmappableChar := true>]
Public Shared Function PathCchStripToRoot (
buffer As StringBuilder,
bufferSize As UInteger
) As HResult
Dim buffer As StringBuilder
Dim bufferSize As UInteger
Dim returnValue As HResult
returnValue = KernelBase.PathCchStripToRoot(buffer,
bufferSize)
public:
[DllImportAttribute(L"KernelBase.dll", CharSet = CharSet::Auto, BestFitMapping = false,
ThrowOnUnmappableChar = true)]
static HResult PathCchStripToRoot(
StringBuilder^ buffer,
unsigned int bufferSize
)
[<DllImportAttribute("KernelBase.dll", CharSet = CharSet.Auto, BestFitMapping = false,
ThrowOnUnmappableChar = true)>]
static member PathCchStripToRoot :
buffer : StringBuilder *
bufferSize : uint32 -> HResult
No code example is currently available or this language may not be supported.
- buffer StringBuilder
-
A pointer to the path string.
When this function returns successfully, this string contains only the root information taken from that path.
- bufferSize UInt32
-
The size of the buffer pointed to by buffer, in characters.
HResult
This function returns
S_OK if the path was truncated,
S_FALSE if the path was already just a root,
or an
HResult failure code.