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

PathCleanupSpec (shell32)
 
.
Summary
Removes illegal characters from a file or directory name. Enforces the 8.3 filename format on drives that do not support long file names.

C# Signature:

[DllImport("shell32.dll", EntryPoint="PathCleanupSpec", CharSet=CharSet.Unicode)]
internal static extern int PathCleanupSpec(
    StringBuilder pszDir,
    [MarshalAs(UnmanagedType.LPWStr)]StringBuilder pszSpec);

VB Signature:

<DllImport("shell32.dll", EntryPoint:="PathCleanupSpec", CharSet:=CharSet.Unicode)> _
Friend Shared Function PathCleanupSpec( _
    ByVal pszDir As StringBuilder, _
    <MarshalAs(UnmanagedType.LPWStr)> ByVal pszSpec As StringBuilder) As Integer
End Function

Sample Code:

const int MAX_PATH = 260;

StringBuilder folderSpec = new StringBuilder(MAX_PATH);
folderSpec.Append(@"D:\");

StringBuilder fileSpec = new StringBuilder(MAX_PATH);
fileSpec.Append("Bad*file?<test>.txt");

int result = NativeMethods.PathCleanupSpec(folderSpec, fileSpec);

Console.WriteLine("FileName: {0}", fileSpec.ToString());

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