Win32 API 日本語リファレンス
ホームSystem.LibraryLoader › AddDllDirectory

AddDllDirectory

関数
DLL検索パスにディレクトリを追加する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSwindows8.0

シグネチャ

// KERNEL32.dll
#include <windows.h>

void* AddDllDirectory(
    LPCWSTR NewDirectory
);

パラメーター

名前方向説明
NewDirectoryLPCWSTRin検索パスに追加するディレクトリへの絶対パス。たとえば、ディレクトリ Dir2 をプロセスの DLL 検索パスに追加するには、\Dir2 を指定します。パスの詳細については、 ファイル、パス、および名前空間の名前付けを参照してください。

戻り値の型: void*

公式ドキュメント

プロセスの DLL 検索パスにディレクトリを追加します。

戻り値

関数が成功した場合、戻り値は不透明なポインターであり、これを RemoveDllDirectory に渡すことで、プロセスの DLL 検索パスから DLL を削除できます。

関数が失敗した場合、戻り値は 0 です。拡張エラー 情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

AddDllDirectory 関数は、DLL の検索対象となるディレクトリの集合に 任意の絶対パスを追加するために使用できます。最初に SetDefaultDllDirectoriesLOAD_LIBRARY_SEARCH_USER_DIRS を指定して呼び出されている場合、 AddDllDirectory で指定されたディレクトリはプロセスの DLL 検索 パスに追加されます。それ以外の場合、 AddDllDirectory 関数で指定されたディレクトリは、 LOAD_LIBRARY_SEARCH_USER_DIRS を指定する LoadLibraryEx 関数の呼び出しに対してのみ使用されます。

AddDllDirectory を使用してプロセスの DLL 検索パスに複数の ディレクトリを追加した場合、それらのディレクトリが検索される順序は規定されていません。

AddDllDirectory で追加したディレクトリを削除するには、 RemoveDllDirectory 関数を使用します。

Windows 7、Windows Server 2008 R2、Windows Vista および Windows Server 2008: この関数をアプリケーションで使用するには、 GetProcAddress を呼び出して、 Kernel32.dll から関数のアドレスを取得します。 対象のプラットフォームに KB2533623 が インストールされている必要があります。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// KERNEL32.dll
#include <windows.h>

void* AddDllDirectory(
    LPCWSTR NewDirectory
);
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern IntPtr AddDllDirectory(
    [MarshalAs(UnmanagedType.LPWStr)] string NewDirectory   // LPCWSTR
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function AddDllDirectory(
    <MarshalAs(UnmanagedType.LPWStr)> NewDirectory As String   ' LPCWSTR
) As IntPtr
End Function
' NewDirectory : LPCWSTR
Declare PtrSafe Function AddDllDirectory Lib "kernel32" ( _
    ByVal NewDirectory As LongPtr) As LongPtr
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

AddDllDirectory = ctypes.windll.kernel32.AddDllDirectory
AddDllDirectory.restype = ctypes.c_void_p
AddDllDirectory.argtypes = [
    wintypes.LPCWSTR,  # NewDirectory : LPCWSTR
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
AddDllDirectory = Fiddle::Function.new(
  lib['AddDllDirectory'],
  [
    Fiddle::TYPE_VOIDP,  # NewDirectory : LPCWSTR
  ],
  Fiddle::TYPE_VOIDP)
#[link(name = "kernel32")]
extern "system" {
    fn AddDllDirectory(
        NewDirectory: *const u16  // LPCWSTR
    ) -> *mut ();
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern IntPtr AddDllDirectory([MarshalAs(UnmanagedType.LPWStr)] string NewDirectory);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_AddDllDirectory' -Namespace Win32 -PassThru
# $api::AddDllDirectory(NewDirectory)
#uselib "KERNEL32.dll"
#func global AddDllDirectory "AddDllDirectory" sptr
; AddDllDirectory NewDirectory   ; 戻り値は stat
; NewDirectory : LPCWSTR -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global AddDllDirectory "AddDllDirectory" wstr
; res = AddDllDirectory(NewDirectory)
; NewDirectory : LPCWSTR -> "wstr"
; void* AddDllDirectory(LPCWSTR NewDirectory)
#uselib "KERNEL32.dll"
#cfunc global AddDllDirectory "AddDllDirectory" wstr
; res = AddDllDirectory(NewDirectory)
; NewDirectory : LPCWSTR -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procAddDllDirectory = kernel32.NewProc("AddDllDirectory")
)

// NewDirectory (LPCWSTR)
r1, _, err := procAddDllDirectory.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(NewDirectory))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // void*
function AddDllDirectory(
  NewDirectory: PWideChar   // LPCWSTR
): Pointer; stdcall;
  external 'KERNEL32.dll' name 'AddDllDirectory';
result := DllCall("KERNEL32\AddDllDirectory"
    , "WStr", NewDirectory   ; LPCWSTR
    , "Ptr")   ; return: void*
●AddDllDirectory(NewDirectory) = DLL("KERNEL32.dll", "void* AddDllDirectory(char*)")
# 呼び出し: AddDllDirectory(NewDirectory)
# NewDirectory : LPCWSTR -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn AddDllDirectory(
    NewDirectory: [*c]const u16 // LPCWSTR
) callconv(std.os.windows.WINAPI) ?*anyopaque;
proc AddDllDirectory(
    NewDirectory: WideCString  # LPCWSTR
): pointer {.importc: "AddDllDirectory", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
void* AddDllDirectory(
    const(wchar)* NewDirectory   // LPCWSTR
);
ccall((:AddDllDirectory, "KERNEL32.dll"), stdcall, Ptr{Cvoid},
      (Cwstring,),
      NewDirectory)
# NewDirectory : LPCWSTR -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
void* AddDllDirectory(
    const uint16_t* NewDirectory);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.AddDllDirectory(NewDirectory)
-- NewDirectory : LPCWSTR
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const AddDllDirectory = lib.func('__stdcall', 'AddDllDirectory', 'void *', ['str16']);
// AddDllDirectory(NewDirectory)
// NewDirectory : LPCWSTR -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  AddDllDirectory: { parameters: ["buffer"], result: "pointer" },
});
// lib.symbols.AddDllDirectory(NewDirectory)
// NewDirectory : LPCWSTR -> "buffer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
void* AddDllDirectory(
    const uint16_t* NewDirectory);
C, "KERNEL32.dll");
// $ffi->AddDllDirectory(NewDirectory);
// NewDirectory : LPCWSTR
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Kernel32 extends StdCallLibrary {
    Kernel32 INSTANCE = Native.load("kernel32", Kernel32.class);
    Pointer AddDllDirectory(
        WString NewDirectory   // LPCWSTR
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun AddDllDirectory = AddDllDirectory(
    NewDirectory : UInt16*   # LPCWSTR
  ) : Void*
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef AddDllDirectoryNative = Pointer<Void> Function(Pointer<Utf16>);
typedef AddDllDirectoryDart = Pointer<Void> Function(Pointer<Utf16>);
final AddDllDirectory = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<AddDllDirectoryNative, AddDllDirectoryDart>('AddDllDirectory');
// NewDirectory : LPCWSTR -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function AddDllDirectory(
  NewDirectory: PWideChar   // LPCWSTR
): Pointer; stdcall;
  external 'KERNEL32.dll' name 'AddDllDirectory';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "AddDllDirectory"
  c_AddDllDirectory :: CWString -> IO (Ptr ())
-- NewDirectory : LPCWSTR -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let adddlldirectory =
  foreign "AddDllDirectory"
    ((ptr uint16_t) @-> returning (ptr void))
(* NewDirectory : LPCWSTR -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("AddDllDirectory" add-dll-directory :convention :stdcall) :pointer
  (new-directory (:string :encoding :utf-16le)))   ; LPCWSTR
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $AddDllDirectory = Win32::API::More->new('KERNEL32',
    'LPVOID AddDllDirectory(LPCWSTR NewDirectory)');
# my $ret = $AddDllDirectory->Call($NewDirectory);
# NewDirectory : LPCWSTR -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。