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

PathCompactPathEx (shlwapi)
 
.
Summary
Truncates a path to fit within a certain number of characters by replacing path components with ellipses.

C# Signature:

[DllImport("shlwapi.dll", CharSet=CharSet.Auto)]
static extern bool PathCompactPathEx([Out] StringBuilder pszOut, string szPath, int cchMax, int dwFlags);

VB Signature:

<DllImport("shlwapi.dll", CharSet:=CharSet.Auto)> _
Shared Function PathCompactPathEx(ByVal pszOut As StringBuilder, _
                   ByVal szPath As String, _
                   ByVal cchMax As Integer, _
                   ByVal dwFlags As Integer) As Boolean
End Function

User-Defined Types:

None.

Notes:

If you have an HDC, take a look at PathCompactPath

Tips & Tricks:

Please add some!

Sample Code:

using System;

using System.Runtime.InteropServices;

using System.Text;

namespace CompactPathCmd

{

    /// <summary>
    /// Summary description for Class1.
    /// </summary>
    class Program
    {
        /// <summary>
        /// The main entry point for the application.
        /// </summary>
        [STAThread]
        static void Main(string[] args)
        {
            string longPath = "c:\\a\\very\\very\\long\\path\\that\\needs\\to\\be\\shortened\\by\\calling\\the\\PathCompactpathEx";
            int length = 40;

            string result = CompactPath(longPath, length);
            Console.WriteLine("     1     2     3     4     5     6     7");
            Console.WriteLine("1234567890123456789012345678901234567890123456789012345678901234567890123456789");
            Console.WriteLine(result);
        }

        [DllImport("shlwapi.dll", CharSet=CharSet.Auto)]
        static extern bool PathCompactPathEx([Out] StringBuilder pszOut, string szPath, int cchMax, int dwFlags);

        public static string CompactPath(string longPathName, int wantedLength)
        {
            StringBuilder sb = new StringBuilder();
            PathCompactPathEx(sb, longPathName, wantedLength, 0);
            return sb.ToString();
        }

    }

}

Alternative Managed API:

Do you know one? Please contribute it!

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
Find References
Show Printable Version
Revisions