GetShortPathName (kernel32)
Last changed: -74.13.52.113

.
Summary

C# Signature:

[DllImport("kernel32.dll", CharSet = CharSet.Auto, SetLastError=true)]
static extern uint GetShortPathName(
   [MarshalAs(UnmanagedType.LPTStr)]
   string lpszLongPath,
   [MarshalAs(UnmanagedType.LPTStr)]
   StringBuilder lpszShortPath,
   uint cchBuffer);

VB.NET Signature:

<DllImport("kernel32.dll", SetLastError:=True, CharSet:=CharSet.Auto)> _
   Public Shared Function GetShortPathName(ByVal longPath As String, _
   <MarshalAs(UnmanagedType.LPTStr)> ByVal ShortPath As StringBuilder, _
   <MarshalAs(UnmanagedType.U4)> ByVal bufferSize As Integer) As Integer
   End Function

C++/CLI Signature:

  [DllImport("kernel32.dll", CharSet = CharSet::Auto, SetLastError=true)]
static int GetShortPathName(
    [MarshalAs(UnmanagedType::LPTStr)]
    String^ lpszLongPath,
    [MarshalAs(UnmanagedType::LPTStr)]
    System::Text::StringBuilder^ lpszShortPath,
    unsigned int cchBuffer);

User-Defined Types:

None.

Notes:

None.

Tips & Tricks:

Please add some!

Sample Code:

/// <summary>
/// The ToLongPathNameToShortPathName function retrieves the short path form of a specified long input path
/// </summary>
/// <param name="longName">The long name path</param>
/// <returns>A short name path string</returns>
public static string ToShortPathName(string longName)
{
    StringBuilder shortNameBuffer = new StringBuilder(256);
    int bufferSize = shortNameBuffer.Capacity;

    int result = GetShortPathName(longName, shortNameBuffer, bufferSize);

    return shortNameBuffer.ToString();
}

VB.NET Sample Code:

/// KSG Comments:
/// Unlike the sample above I am check for the return code in the event of an error
Public Class Interop
   <DllImport("kernel32.dll", SetLastError:=True, CharSet:=CharSet.Auto)> _
   Public Shared Function GetShortPathName(ByVal longPath As String, <MarshalAs(UnmanagedType.LPTStr)> ByVal ShortPath As StringBuilder, <MarshalAs(UnmanagedType.U4)> ByVal bufferSize As Integer) As Integer
   End Function
End Class

Private Sub TestShortPath()
   Dim sb As New StringBuilder(1024)
   Dim longPath As String
   Dim sFileName As String
   longPath = Environment.GetFolderPath(Environment.SpecialFolder.Personal)
   Dim retVal As Integer = Interop.GetShortPathName(longPath, sb, 1024)
   If retVal <> 0 Then
      Dim sTemp As String = sb.ToString()
      MessageBox.Show(sTemp)
   Else
      Console.WriteLine("Error occured. GetLastError returns {0}.", Marshal.GetLastWin32Error())
   End If
End Sub

Alternative Managed API:

Do you know one? Please contribute it!

Documentation