Search
Module:
Directory

   Desktop Functions:

   Smart Device Functions:


Show Recent Changes
Subscribe (RSS)
Misc. Pages
Comments
FAQ
Helpful Tools
Playground
Suggested Reading
Website TODO List
Download Visual Studio Add-In

PathStripToRoot (shlwapi)
 
.
Summary
PathStripToRoot - Removes all parts of the path except for the root information.

C# Signature:

/// <summary>
/// Removes all parts of the path except for the root information.
/// </summary>
/// <param name="pszPath">A pointer to a null-terminated string of length MAX_PATH that contains the path to be converted. When this function returns successfully, this string contains only the root information taken from that path.</param>
/// <returns>Returns TRUE if a valid drive letter was found in the path, or FALSE otherwise.</returns>
[DllImport("shlwapi.dll", EntryPoint = "PathStripToRootW",  SetLastError = true, CharSet = CharSet.Unicode)]
[return: MarshalAs(UnmanagedType.Bool)]
static extern bool PathStripToRoot([MarshalAs(UnmanagedType.LPTStr)]string pszPath);

VB.NET Signature:

''' <summary>
''' Removes all parts of the path except for the root information.
''' </summary>
''' <param name="pszPath">A pointer to a null-terminated string of length MAX_PATH that contains the path to be converted. When this function returns successfully, this string contains only the root information taken from that path.</param>
''' <returns>Returns TRUE if a valid drive letter was found in the path, or FALSE otherwise.</returns>
<DllImport("shlwapi.dll", EntryPoint:="PathStripToRootW",  SetLastError:=true, CharSet:=CharSet.Unicode)> _
Public Function PathStripToRoot(<MarshalAs(UnmanagedType.LPTStr)>pszPath As String) As <MarshalAs(UnmanagedType.Bool)>Boolean
End Function

VB Signature:

Public Declare Function PathStripToRoot Lib "shlwapi" Alias "PathStripToRootA" _
        (ByVal szRoot As String) As Long

User-Defined Types:

None.

Alternative Managed API:

Do you know one? Please contribute it!

Notes:

None.

Tips & Tricks:

Please add some!

Sample Code:

Please add some!

Documentation

Please edit this page!

Do you have...

  • helpful tips or sample code to share for using this API in managed code?
  • corrections to the existing content?
  • variations of the signature you want to share?
  • additional languages you want to include?

Select "Edit This Page" on the right hand toolbar and edit it! Or add new pages containing supporting types needed for this API (structures, delegates, and more).

 
Access PInvoke.net directly from VS:
Terms of Use
Edit This Page
Find References
Show Printable Version
Revisions