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

PathFindOnPath (shlwapi)
 
.
Summary
Searches the current PATH for the specified file

C# Signature:

[DllImport("shlwapi.dll", SetLastError=true)]
[DllImport("shlwapi.dll", CharSet=CharSet.Auto, SetLastError=false)]
static extern bool PathFindOnPath([In, Out] StringBuilder pszFile, [In] String [] ppszOtherDirs);

VB Signature:

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

Notes:

Make sure pszFile has enough space for MAX_PATH characters.

ppszOtherDirs is a list of specific directories to search first. It can be null if you want to search only the PATH.

If you pass some additional directories in ppszOtherDirs, be sure to add an extra null to the array (otherwise, it will crash in case the file is not found).

ppszOtherDirs is a list of specific directories to search first. It can be null if you want to search only the PATH.

This function does not include the current dir or the application launch dir in its search.

Tips & Tricks:

None.

Sample Code:

int MAX_PATH=260;

StringBuilder sb = new StringBuilder("somefile.dll", MAX_PATH);
bool found = PathFindOnPath(sb, new String [] {"c:\\test", "c:\\junk", null} );
bool found = PathFindOnPath(sb, new String [] {"c:\\test", "c:\\junk"} );
if (found)
{
    Console.WriteLine("File was found at: " + sb.ToString());
}
else
{
    Console.WriteLine("File was not found");
}

Alternative Managed API:

None that I could find.

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