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

SetDefaultDllDirectories

関数
DLLの既定の検索ディレクトリを設定する。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSwindows8.0

シグネチャ

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

BOOL SetDefaultDllDirectories(
    LOAD_LIBRARY_FLAGS DirectoryFlags
);

パラメーター

名前方向説明
DirectoryFlagsLOAD_LIBRARY_FLAGSin

検索対象とするディレクトリ。このパラメーターには、次の値の任意の組み合わせを指定できます。

意味
LOAD_LIBRARY_SEARCH_APPLICATION_DIR
0x00000200
この値を使用すると、アプリケーションのインストール ディレクトリが検索されます。
LOAD_LIBRARY_SEARCH_DEFAULT_DIRS
0x00001000
この値は、LOAD_LIBRARY_SEARCH_APPLICATION_DIRLOAD_LIBRARY_SEARCH_SYSTEM32、および LOAD_LIBRARY_SEARCH_USER_DIRS を組み合わせたものです。

この値は、アプリケーションが DLL 検索パスに含めるべきディレクトリ数の推奨される最大値を表します。

LOAD_LIBRARY_SEARCH_SYSTEM32
0x00000800
この値を使用すると、%windows%\system32 が検索されます。
LOAD_LIBRARY_SEARCH_USER_DIRS
0x00000400
この値を使用すると、 AddDllDirectory 関数または SetDllDirectory 関数を使用して明示的に追加されたパスが検索されます。複数のディレクトリが追加されている場合、それらが検索される順序は規定されていません。

戻り値の型: BOOL

公式ドキュメント

呼び出し元プロセスが DLL を読み込む際に検索する既定のディレクトリ群を指定します。この検索パスは、LOAD_LIBRARY_SEARCH フラグを指定せずに LoadLibraryEx を呼び出したときに使用されます。

戻り値

関数が成功した場合、戻り値は 0 以外の値です。

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

解説(Remarks)

DLL 検索パスとは、LoadLibrary または LoadLibraryEx 関数の呼び出しでフル パスが指定されていない場合、あるいは DLL のフル パスは指定されているものの、依存する DLL をシステムが検索する必要がある場合に、DLL を探すために検索されるディレクトリの集合です。標準の DLL 検索パスの詳細については、 Dynamic-Link Library Search Order を参照してください。

標準の DLL 検索パスには、DLL プリロード攻撃に対して脆弱になり得るディレクトリが含まれています。アプリケーションは、SetDefaultDllDirectories 関数を使用して、最も脆弱なディレクトリを除外し、検索対象となるその他のディレクトリを制限した、プロセスの既定の DLL 検索パスを指定できます。プロセスの DLL 検索パスは呼び出し元プロセスにのみ適用され、プロセスの存続期間にわたって保持されます。

DirectoryFlags パラメーターに複数のフラグを指定した場合、ディレクトリは次の順序で検索されます。

SetDefaultDllDirectoriesLOAD_LIBRARY_SEARCH_USER_DIRS を指定しない場合、AddDllDirectory 関数で指定されたディレクトリは、LOAD_LIBRARY_SEARCH_USER_DIRS を指定する LoadLibraryEx 関数の呼び出しに対してのみ使用されます。

標準の DLL 検索パスに戻したり、SetDefaultDllDirectories で指定したディレクトリを検索パスから削除したりすることはできません。ただし、プロセスの DLL 検索パスは、1 つ以上の LOAD_LIBRARY_SEARCH フラグを指定して LoadLibraryEx を呼び出すことでオーバーライドできます。また、 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>

BOOL SetDefaultDllDirectories(
    LOAD_LIBRARY_FLAGS DirectoryFlags
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetDefaultDllDirectories(
    uint DirectoryFlags   // LOAD_LIBRARY_FLAGS
);
<DllImport("KERNEL32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetDefaultDllDirectories(
    DirectoryFlags As UInteger   ' LOAD_LIBRARY_FLAGS
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' DirectoryFlags : LOAD_LIBRARY_FLAGS
Declare PtrSafe Function SetDefaultDllDirectories Lib "kernel32" ( _
    ByVal DirectoryFlags As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetDefaultDllDirectories = ctypes.windll.kernel32.SetDefaultDllDirectories
SetDefaultDllDirectories.restype = wintypes.BOOL
SetDefaultDllDirectories.argtypes = [
    wintypes.DWORD,  # DirectoryFlags : LOAD_LIBRARY_FLAGS
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('KERNEL32.dll')
SetDefaultDllDirectories = Fiddle::Function.new(
  lib['SetDefaultDllDirectories'],
  [
    -Fiddle::TYPE_INT,  # DirectoryFlags : LOAD_LIBRARY_FLAGS
  ],
  Fiddle::TYPE_INT)
#[link(name = "kernel32")]
extern "system" {
    fn SetDefaultDllDirectories(
        DirectoryFlags: u32  // LOAD_LIBRARY_FLAGS
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("KERNEL32.dll", SetLastError = true)]
public static extern bool SetDefaultDllDirectories(uint DirectoryFlags);
"@
$api = Add-Type -MemberDefinition $sig -Name 'KERNEL32_SetDefaultDllDirectories' -Namespace Win32 -PassThru
# $api::SetDefaultDllDirectories(DirectoryFlags)
#uselib "KERNEL32.dll"
#func global SetDefaultDllDirectories "SetDefaultDllDirectories" sptr
; SetDefaultDllDirectories DirectoryFlags   ; 戻り値は stat
; DirectoryFlags : LOAD_LIBRARY_FLAGS -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "KERNEL32.dll"
#cfunc global SetDefaultDllDirectories "SetDefaultDllDirectories" int
; res = SetDefaultDllDirectories(DirectoryFlags)
; DirectoryFlags : LOAD_LIBRARY_FLAGS -> "int"
; BOOL SetDefaultDllDirectories(LOAD_LIBRARY_FLAGS DirectoryFlags)
#uselib "KERNEL32.dll"
#cfunc global SetDefaultDllDirectories "SetDefaultDllDirectories" int
; res = SetDefaultDllDirectories(DirectoryFlags)
; DirectoryFlags : LOAD_LIBRARY_FLAGS -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procSetDefaultDllDirectories = kernel32.NewProc("SetDefaultDllDirectories")
)

// DirectoryFlags (LOAD_LIBRARY_FLAGS)
r1, _, err := procSetDefaultDllDirectories.Call(
	uintptr(DirectoryFlags),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetDefaultDllDirectories(
  DirectoryFlags: DWORD   // LOAD_LIBRARY_FLAGS
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetDefaultDllDirectories';
result := DllCall("KERNEL32\SetDefaultDllDirectories"
    , "UInt", DirectoryFlags   ; LOAD_LIBRARY_FLAGS
    , "Int")   ; return: BOOL
●SetDefaultDllDirectories(DirectoryFlags) = DLL("KERNEL32.dll", "bool SetDefaultDllDirectories(dword)")
# 呼び出し: SetDefaultDllDirectories(DirectoryFlags)
# DirectoryFlags : LOAD_LIBRARY_FLAGS -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "kernel32" fn SetDefaultDllDirectories(
    DirectoryFlags: u32 // LOAD_LIBRARY_FLAGS
) callconv(std.os.windows.WINAPI) i32;
proc SetDefaultDllDirectories(
    DirectoryFlags: uint32  # LOAD_LIBRARY_FLAGS
): int32 {.importc: "SetDefaultDllDirectories", stdcall, dynlib: "KERNEL32.dll".}
pragma(lib, "kernel32");
extern(Windows)
int SetDefaultDllDirectories(
    uint DirectoryFlags   // LOAD_LIBRARY_FLAGS
);
ccall((:SetDefaultDllDirectories, "KERNEL32.dll"), stdcall, Int32,
      (UInt32,),
      DirectoryFlags)
# DirectoryFlags : LOAD_LIBRARY_FLAGS -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
int32_t SetDefaultDllDirectories(
    uint32_t DirectoryFlags);
]]
local kernel32 = ffi.load("kernel32")
-- kernel32.SetDefaultDllDirectories(DirectoryFlags)
-- DirectoryFlags : LOAD_LIBRARY_FLAGS
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('KERNEL32.dll');
const SetDefaultDllDirectories = lib.func('__stdcall', 'SetDefaultDllDirectories', 'int32_t', ['uint32_t']);
// SetDefaultDllDirectories(DirectoryFlags)
// DirectoryFlags : LOAD_LIBRARY_FLAGS -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("KERNEL32.dll", {
  SetDefaultDllDirectories: { parameters: ["u32"], result: "i32" },
});
// lib.symbols.SetDefaultDllDirectories(DirectoryFlags)
// DirectoryFlags : LOAD_LIBRARY_FLAGS -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
int32_t SetDefaultDllDirectories(
    uint32_t DirectoryFlags);
C, "KERNEL32.dll");
// $ffi->SetDefaultDllDirectories(DirectoryFlags);
// DirectoryFlags : LOAD_LIBRARY_FLAGS
// 構造体/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);
    boolean SetDefaultDllDirectories(
        int DirectoryFlags   // LOAD_LIBRARY_FLAGS
    );
}
@[Link("kernel32")]
lib LibKERNEL32
  fun SetDefaultDllDirectories = SetDefaultDllDirectories(
    DirectoryFlags : UInt32   # LOAD_LIBRARY_FLAGS
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef SetDefaultDllDirectoriesNative = Int32 Function(Uint32);
typedef SetDefaultDllDirectoriesDart = int Function(int);
final SetDefaultDllDirectories = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<SetDefaultDllDirectoriesNative, SetDefaultDllDirectoriesDart>('SetDefaultDllDirectories');
// DirectoryFlags : LOAD_LIBRARY_FLAGS -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetDefaultDllDirectories(
  DirectoryFlags: DWORD   // LOAD_LIBRARY_FLAGS
): BOOL; stdcall;
  external 'KERNEL32.dll' name 'SetDefaultDllDirectories';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetDefaultDllDirectories"
  c_SetDefaultDllDirectories :: Word32 -> IO CInt
-- DirectoryFlags : LOAD_LIBRARY_FLAGS -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let setdefaultdlldirectories =
  foreign "SetDefaultDllDirectories"
    (uint32_t @-> returning int32_t)
(* DirectoryFlags : LOAD_LIBRARY_FLAGS -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library kernel32 (t "KERNEL32.dll"))
(cffi:use-foreign-library kernel32)

(cffi:defcfun ("SetDefaultDllDirectories" set-default-dll-directories :convention :stdcall) :int32
  (directory-flags :uint32))   ; LOAD_LIBRARY_FLAGS
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetDefaultDllDirectories = Win32::API::More->new('KERNEL32',
    'BOOL SetDefaultDllDirectories(DWORD DirectoryFlags)');
# my $ret = $SetDefaultDllDirectories->Call($DirectoryFlags);
# DirectoryFlags : LOAD_LIBRARY_FLAGS -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目
使用する型