Specify the search path for DllImport in .NET

.NetDllimport

.Net Problem Overview


Is there a way to specify the paths to be searched for a given assembly that is imported with DllImport?

[DllImport("MyDll.dll")]
static extern void Func();

This will search for the dll in the app dir and in the PATH environment variable. But at times the dll will be placed elsewhere. Can this information be specified in app.config or manifest file to avoid dynamic loading and dynamic invocation?

.Net Solutions


Solution 1 - .Net

Call SetDllDirectory with your additional DLL paths before you call into the imported function for the first time.

P/Invoke signature:

[DllImport("kernel32.dll", SetLastError = true)]
static extern bool SetDllDirectory(string lpPathName);

To set more than one additional DLL search path, modify the PATH environment variable, e.g.:

static void AddEnvironmentPaths(string[] paths)
{
    string path = Environment.GetEnvironmentVariable("PATH") ?? string.Empty;
    path += ";" + string.Join(";", paths);

    Environment.SetEnvironmentVariable("PATH", path);
}

There's more info about the DLL search order here on MSDN.


Updated 2013/07/30:

Updated version of the above using Path.PathSeparator:

static void AddEnvironmentPaths(IEnumerable<string> paths)
{
    var path = new[] { Environment.GetEnvironmentVariable("PATH") ?? string.Empty };

    string newPath = string.Join(Path.PathSeparator.ToString(), path.Concat(paths));

    Environment.SetEnvironmentVariable("PATH", newPath);
}

Solution 2 - .Net

Try calling AddDllDirectory with your additional DLL paths before you call into the imported function for the first time.

If your Windows version is lower than 8 you will need to install this patch, which extends the API with the missing AddDllDirectory function for Windows 7, 2008 R2, 2008 and Vista (there is no patch for XP, though).

Solution 3 - .Net

This might be useful DefaultDllImportSearchPathsAttribute Class
E.g.

[assembly: DefaultDllImportSearchPaths(DllImportSearchPath.UserDirectories)]

Also note you can use AddDllDirectory as well so you aren't screwing up anything already there:

[DllImport("kernel32.dll", SetLastError = true)]
static extern bool AddDllDirectory(string path);

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionStefanView Question on Stackoverflow
Solution 1 - .NetChris SchmichView Answer on Stackoverflow
Solution 2 - .NetjvrdevView Answer on Stackoverflow
Solution 3 - .NetEricView Answer on Stackoverflow