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

PathRelativePathTo (shlwapi)
 
.
Summary
Creates a relative path from one file or folder to another.

C# Signature:

[DllImport("shlwapi.dll")]
public static extern Int32 PathRelativePathTo(
     [Out] StringBuilder pszPath,
     [In] String pszFrom,
     [In] UInt32 dwAttrFrom,
     [In] String pszTo,
     [In] UInt32 dwAttrTo
);
const UInt32 FILE_ATTRIBUTE_DIRECTORY = 0x10;
const Int32 MAX_PATH = 260;

VB Signature:

Declare Function PathRelativePathTo Lib "shlwapi.dll" (TODO) As TODO

User-Defined Types:

None.

Notes:

None.

Tips & Tricks:

Please add some!

Sample Code:

StringBuilder str = new StringBuilder(MAX_PATH);
UInt32 dwAttr1, dwAttr2;
dwAttr1 = FILE_ATTRIBUTE_DIRECTORY;
dwAttr2 = 0;
Int32 nRet = PathRelativePathTo(
     str,
     @"c:\a\b\path", dwAttr1,
     @"c:\a\x\y\file", dwAttr2
     );
// Result: str.ToString() == @"..\..\x\y\file"

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