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

PathCompactPath (shlwapi)
 
.
Summary
Truncates a file path to fit within a given pixel width by replacing path components with ellipses. The path parameter must be preallocated to MAX_PATH length in order to avoid a buffer overrun / corruption.

C# Signature:

[DllImport("shlwapi.dll", CharSet=CharSet.Auto)]
static extern bool PathCompactPath(IntPtr hDC, [In, Out] StringBuilder pszPath, int dx);

VB Signature:

Declare Function PathCompactPath Lib "shlwapi" (ByVal hDC As IntPtr, <MarshalAs(UnmanagedType.VBByRefStr, sizeConst:=MAX_PATH)> lpszPath As String, ByVal dx As Int32) As Boolean

User-Defined Types:

None.

Notes:

If you do not have a HDC available, take a look at PathCompactPathEx

Tips & Tricks:

Please add some!

Sample Code:

public partial class frmMain : Form

{

    [DllImport("shlwapi.dll", CharSet = CharSet.Auto)]
    static extern bool PathCompactPath(IntPtr hDC, [In, Out] StringBuilder pszPath, int dx);

    public string PathCompactPath(string path, int pixel)
    {
    Graphics gc = this.CreateGraphics();
    StringBuilder strBuffer = new StringBuilder(path);
    PathCompactPath((IntPtr)gc.GetHdc(), strBuffer, pixel);
    return strBuffer.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