ホーム › System.LibraryLoader › QueryOptionalDelayLoadedAPI

QueryOptionalDelayLoadedAPI

関数

遅延読み込みAPIが利用可能かどうかを照会する。

DLLapi-ms-win-core-libraryloader-l2-1-0.dll呼出規約winapiSetLastErrorあり対応OSWindows 10 以降

シグネチャ

// api-ms-win-core-libraryloader-l2-1-0.dll
#include <windows.h>

BOOL QueryOptionalDelayLoadedAPI(
    HMODULE hParentModule,
    LPCSTR lpDllName,
    LPCSTR lpProcName,
    DWORD Reserved   // optional
);

パラメーター

名前	型	方向	説明
hParentModule	HMODULE	in	呼び出し元モジュールへのハンドル。デスクトップアプリケーションは、GetModuleHandle 関数または GetModuleHandleEx 関数を使用してこのハンドルを取得できます。Windows ストアアプリは、このパラメーターに `static_cast<HMODULE>(&__ImageBase)` を設定する必要があります。
lpDllName	LPCSTR	in	指定された関数をエクスポートする遅延読み込み DLL のファイル名。このパラメーターは大文字と小文字を区別しません。 Windows ストアアプリでは、モノリシックな DLL ではなく API セットを指定する必要があります。たとえば、kernel32.dll ではなく api-ms-win-core-memory-l1-1-1.dll を指定します。
lpProcName	LPCSTR	in	クエリ対象の関数名。このパラメーターは大文字と小文字を区別します。
Reserved	DWORD	optional	このパラメーターは予約されており、0 を指定する必要があります。

戻り値の型: BOOL

公式ドキュメント

遅延読み込み DLL 内の指定された関数が、システム上で利用可能かどうかを判定します。

戻り値

指定された関数がシステム上で利用可能な場合は TRUE。指定された関数がシステム上で利用できない場合、この関数は FALSE を返します。拡張エラー情報を取得するには、GetLastError を呼び出します。

解説(Remarks)

遅延読み込み DLL は静的にリンクされますが、実行中のアプリケーションがその DLL からエクスポートされたシンボルを参照するまで、実際にはメモリに読み込まれません。アプリケーションでは、めったに呼び出さない、あるいはまったく呼び出さない可能性のある関数を含む DLL を遅延読み込みすることがよくあります。これは、他の静的にリンクされた DLL のようにアプリケーションの起動時に読み込まれるのではなく、必要なときにのみ DLL が読み込まれるためです。これは、特に初期化時のアプリケーションのパフォーマンス向上に役立ちます。遅延読み込み DLL は、リンク時に /DELAYLOAD (Delay Load Import) リンカーオプションで指定します。

複数のバージョンの Windows や複数の Windows デバイスファミリを対象とするアプリケーションも、利用可能なときに追加機能を有効にするために遅延読み込み DLL を利用します。

デスクトップアプリケーションは、LoadLibrary または LoadLibraryEx を使用して DLL を読み込み、GetProcAddress を使用して関数へのポインターを取得する実行時動的リンクの代替手段として、遅延読み込みを使用できます。Windows ストアアプリは LoadLibrary や LoadLibraryEx を使用できないため、実行時動的リンクの利点を得るには、遅延読み込みのメカニズムを使用する必要があります。

遅延読み込み DLL 内の関数がシステム上で利用可能かどうかを確認するには、アプリケーションは指定した関数を引数として QueryOptionalDelayLoadedAPI を呼び出します。QueryOptionalDelayLoadedAPI が成功した場合、アプリケーションは指定した関数を安全に呼び出すことができます。

Examples

次の例は、MkParseDisplayName 関数がシステム上で利用可能かどうかを判定するために QueryOptionalDelayLoadedAPI を使用する方法を示しています。

#include <windows.h>
#include <libloaderapi2.h>

// For this example, you need to pass
// /delayload: ext-ms-win-com-ole32-l1-1-1.dll to link.exe.

EXTERN_C IMAGE_DOS_HEADER __ImageBase;

BOOL
AreMonikersSupported ()
{

    BOOL isApiAvailable;

    // Check if MkParseDisplayName is available on the system. It is only
    // available on desktop computers, and not on mobile devices or Xbox.

    isApiAvailable = 
        QueryOptionalDelayLoadedAPI(static_cast<HMODULE>(&__ImageBase),
                                    "ext-ms-win-com-ole32-l1-1-1.dll",
                                    "MkParseDisplayName",
                                    0);

    return isApiAvailable;
}

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

各言語での呼び出し定義

// api-ms-win-core-libraryloader-l2-1-0.dll
#include <windows.h>

BOOL QueryOptionalDelayLoadedAPI(
    HMODULE hParentModule,
    LPCSTR lpDllName,
    LPCSTR lpProcName,
    DWORD Reserved   // optional
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("api-ms-win-core-libraryloader-l2-1-0.dll", SetLastError = true, ExactSpelling = true)]
static extern bool QueryOptionalDelayLoadedAPI(
    IntPtr hParentModule,   // HMODULE
    [MarshalAs(UnmanagedType.LPStr)] string lpDllName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string lpProcName,   // LPCSTR
    uint Reserved   // DWORD optional
);

<DllImport("api-ms-win-core-libraryloader-l2-1-0.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function QueryOptionalDelayLoadedAPI(
    hParentModule As IntPtr,   ' HMODULE
    <MarshalAs(UnmanagedType.LPStr)> lpDllName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> lpProcName As String,   ' LPCSTR
    Reserved As UInteger   ' DWORD optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' hParentModule : HMODULE
' lpDllName : LPCSTR
' lpProcName : LPCSTR
' Reserved : DWORD optional
Declare PtrSafe Function QueryOptionalDelayLoadedAPI Lib "api-ms-win-core-libraryloader-l2-1-0" ( _
    ByVal hParentModule As LongPtr, _
    ByVal lpDllName As String, _
    ByVal lpProcName As String, _
    ByVal Reserved As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

QueryOptionalDelayLoadedAPI = ctypes.windll.LoadLibrary("api-ms-win-core-libraryloader-l2-1-0.dll").QueryOptionalDelayLoadedAPI
QueryOptionalDelayLoadedAPI.restype = wintypes.BOOL
QueryOptionalDelayLoadedAPI.argtypes = [
    wintypes.HANDLE,  # hParentModule : HMODULE
    wintypes.LPCSTR,  # lpDllName : LPCSTR
    wintypes.LPCSTR,  # lpProcName : LPCSTR
    wintypes.DWORD,  # Reserved : DWORD optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('api-ms-win-core-libraryloader-l2-1-0.dll')
QueryOptionalDelayLoadedAPI = Fiddle::Function.new(
  lib['QueryOptionalDelayLoadedAPI'],
  [
    Fiddle::TYPE_VOIDP,  # hParentModule : HMODULE
    Fiddle::TYPE_VOIDP,  # lpDllName : LPCSTR
    Fiddle::TYPE_VOIDP,  # lpProcName : LPCSTR
    -Fiddle::TYPE_INT,  # Reserved : DWORD optional
  ],
  Fiddle::TYPE_INT)

#[link(name = "api-ms-win-core-libraryloader-l2-1-0")]
extern "system" {
    fn QueryOptionalDelayLoadedAPI(
        hParentModule: *mut core::ffi::c_void,  // HMODULE
        lpDllName: *const u8,  // LPCSTR
        lpProcName: *const u8,  // LPCSTR
        Reserved: u32  // DWORD optional
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("api-ms-win-core-libraryloader-l2-1-0.dll", SetLastError = true)]
public static extern bool QueryOptionalDelayLoadedAPI(IntPtr hParentModule, [MarshalAs(UnmanagedType.LPStr)] string lpDllName, [MarshalAs(UnmanagedType.LPStr)] string lpProcName, uint Reserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'api-ms-win-core-libraryloader-l2-1-0_QueryOptionalDelayLoadedAPI' -Namespace Win32 -PassThru
# $api::QueryOptionalDelayLoadedAPI(hParentModule, lpDllName, lpProcName, Reserved)

#uselib "api-ms-win-core-libraryloader-l2-1-0.dll"
#func global QueryOptionalDelayLoadedAPI "QueryOptionalDelayLoadedAPI" sptr, sptr, sptr, sptr
; QueryOptionalDelayLoadedAPI hParentModule, lpDllName, lpProcName, Reserved   ; 戻り値は stat
; hParentModule : HMODULE -> "sptr"
; lpDllName : LPCSTR -> "sptr"
; lpProcName : LPCSTR -> "sptr"
; Reserved : DWORD optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

#uselib "api-ms-win-core-libraryloader-l2-1-0.dll"
#cfunc global QueryOptionalDelayLoadedAPI "QueryOptionalDelayLoadedAPI" sptr, str, str, int
; res = QueryOptionalDelayLoadedAPI(hParentModule, lpDllName, lpProcName, Reserved)
; hParentModule : HMODULE -> "sptr"
; lpDllName : LPCSTR -> "str"
; lpProcName : LPCSTR -> "str"
; Reserved : DWORD optional -> "int"

; BOOL QueryOptionalDelayLoadedAPI(HMODULE hParentModule, LPCSTR lpDllName, LPCSTR lpProcName, DWORD Reserved)
#uselib "api-ms-win-core-libraryloader-l2-1-0.dll"
#cfunc global QueryOptionalDelayLoadedAPI "QueryOptionalDelayLoadedAPI" intptr, str, str, int
; res = QueryOptionalDelayLoadedAPI(hParentModule, lpDllName, lpProcName, Reserved)
; hParentModule : HMODULE -> "intptr"
; lpDllName : LPCSTR -> "str"
; lpProcName : LPCSTR -> "str"
; Reserved : DWORD optional -> "int"

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	api_ms_win_core_libraryloader_l2_1_0 = windows.NewLazySystemDLL("api-ms-win-core-libraryloader-l2-1-0.dll")
	procQueryOptionalDelayLoadedAPI = api_ms_win_core_libraryloader_l2_1_0.NewProc("QueryOptionalDelayLoadedAPI")
)

// hParentModule (HMODULE), lpDllName (LPCSTR), lpProcName (LPCSTR), Reserved (DWORD optional)
r1, _, err := procQueryOptionalDelayLoadedAPI.Call(
	uintptr(hParentModule),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpDllName))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(lpProcName))),
	uintptr(Reserved),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL

function QueryOptionalDelayLoadedAPI(
  hParentModule: THandle;   // HMODULE
  lpDllName: PAnsiChar;   // LPCSTR
  lpProcName: PAnsiChar;   // LPCSTR
  Reserved: DWORD   // DWORD optional
): BOOL; stdcall;
  external 'api-ms-win-core-libraryloader-l2-1-0.dll' name 'QueryOptionalDelayLoadedAPI';

result := DllCall("api-ms-win-core-libraryloader-l2-1-0\QueryOptionalDelayLoadedAPI"
    , "Ptr", hParentModule   ; HMODULE
    , "AStr", lpDllName   ; LPCSTR
    , "AStr", lpProcName   ; LPCSTR
    , "UInt", Reserved   ; DWORD optional
    , "Int")   ; return: BOOL

●QueryOptionalDelayLoadedAPI(hParentModule, lpDllName, lpProcName, Reserved) = DLL("api-ms-win-core-libraryloader-l2-1-0.dll", "bool QueryOptionalDelayLoadedAPI(void*, char*, char*, dword)")
# 呼び出し: QueryOptionalDelayLoadedAPI(hParentModule, lpDllName, lpProcName, Reserved)
# hParentModule : HMODULE -> "void*"
# lpDllName : LPCSTR -> "char*"
# lpProcName : LPCSTR -> "char*"
# Reserved : DWORD optional -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。

const std = @import("std");

extern "api-ms-win-core-libraryloader-l2-1-0" fn QueryOptionalDelayLoadedAPI(
    hParentModule: ?*anyopaque, // HMODULE
    lpDllName: [*c]const u8, // LPCSTR
    lpProcName: [*c]const u8, // LPCSTR
    Reserved: u32 // DWORD optional
) callconv(std.os.windows.WINAPI) i32;

proc QueryOptionalDelayLoadedAPI(
    hParentModule: pointer,  # HMODULE
    lpDllName: cstring,  # LPCSTR
    lpProcName: cstring,  # LPCSTR
    Reserved: uint32  # DWORD optional
): int32 {.importc: "QueryOptionalDelayLoadedAPI", stdcall, dynlib: "api-ms-win-core-libraryloader-l2-1-0.dll".}

pragma(lib, "api-ms-win-core-libraryloader-l2-1-0");
extern(Windows)
int QueryOptionalDelayLoadedAPI(
    void* hParentModule,   // HMODULE
    const(char)* lpDllName,   // LPCSTR
    const(char)* lpProcName,   // LPCSTR
    uint Reserved   // DWORD optional
);

ccall((:QueryOptionalDelayLoadedAPI, "api-ms-win-core-libraryloader-l2-1-0.dll"), stdcall, Int32,
      (Ptr{Cvoid}, Cstring, Cstring, UInt32),
      hParentModule, lpDllName, lpProcName, Reserved)
# hParentModule : HMODULE -> Ptr{Cvoid}
# lpDllName : LPCSTR -> Cstring
# lpProcName : LPCSTR -> Cstring
# Reserved : DWORD optional -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。

local ffi = require("ffi")
ffi.cdef[[
int32_t QueryOptionalDelayLoadedAPI(
    void* hParentModule,
    const char* lpDllName,
    const char* lpProcName,
    uint32_t Reserved);
]]
local api-ms-win-core-libraryloader-l2-1-0 = ffi.load("api-ms-win-core-libraryloader-l2-1-0")
-- api-ms-win-core-libraryloader-l2-1-0.QueryOptionalDelayLoadedAPI(hParentModule, lpDllName, lpProcName, Reserved)
-- hParentModule : HMODULE
-- lpDllName : LPCSTR
-- lpProcName : LPCSTR
-- Reserved : DWORD optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。

const koffi = require('koffi');
const lib = koffi.load('api-ms-win-core-libraryloader-l2-1-0.dll');
const QueryOptionalDelayLoadedAPI = lib.func('__stdcall', 'QueryOptionalDelayLoadedAPI', 'int32_t', ['void *', 'str', 'str', 'uint32_t']);
// QueryOptionalDelayLoadedAPI(hParentModule, lpDllName, lpProcName, Reserved)
// hParentModule : HMODULE -> 'void *'
// lpDllName : LPCSTR -> 'str'
// lpProcName : LPCSTR -> 'str'
// Reserved : DWORD optional -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("api-ms-win-core-libraryloader-l2-1-0.dll", {
  QueryOptionalDelayLoadedAPI: { parameters: ["pointer", "buffer", "buffer", "u32"], result: "i32" },
});
// lib.symbols.QueryOptionalDelayLoadedAPI(hParentModule, lpDllName, lpProcName, Reserved)
// hParentModule : HMODULE -> "pointer"
// lpDllName : LPCSTR -> "buffer"
// lpProcName : LPCSTR -> "buffer"
// Reserved : DWORD optional -> "u32"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
int32_t QueryOptionalDelayLoadedAPI(
    void* hParentModule,
    const char* lpDllName,
    const char* lpProcName,
    uint32_t Reserved);
C, "api-ms-win-core-libraryloader-l2-1-0.dll");
// $ffi->QueryOptionalDelayLoadedAPI(hParentModule, lpDllName, lpProcName, Reserved);
// hParentModule : HMODULE
// lpDllName : LPCSTR
// lpProcName : LPCSTR
// Reserved : DWORD optional
// 構造体/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 Api-ms-win-core-libraryloader-l2-1-0 extends StdCallLibrary {
    Api-ms-win-core-libraryloader-l2-1-0 INSTANCE = Native.load("api-ms-win-core-libraryloader-l2-1-0", Api-ms-win-core-libraryloader-l2-1-0.class);
    boolean QueryOptionalDelayLoadedAPI(
        Pointer hParentModule,   // HMODULE
        String lpDllName,   // LPCSTR
        String lpProcName,   // LPCSTR
        int Reserved   // DWORD optional
    );
}

@[Link("api-ms-win-core-libraryloader-l2-1-0")]
lib Libapi-ms-win-core-libraryloader-l2-1-0
  fun QueryOptionalDelayLoadedAPI = QueryOptionalDelayLoadedAPI(
    hParentModule : Void*,   # HMODULE
    lpDllName : UInt8*,   # LPCSTR
    lpProcName : UInt8*,   # LPCSTR
    Reserved : UInt32   # DWORD optional
  ) : Int32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。

import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef QueryOptionalDelayLoadedAPINative = Int32 Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, Uint32);
typedef QueryOptionalDelayLoadedAPIDart = int Function(Pointer<Void>, Pointer<Utf8>, Pointer<Utf8>, int);
final QueryOptionalDelayLoadedAPI = DynamicLibrary.open('api-ms-win-core-libraryloader-l2-1-0.dll')
    .lookupFunction<QueryOptionalDelayLoadedAPINative, QueryOptionalDelayLoadedAPIDart>('QueryOptionalDelayLoadedAPI');
// hParentModule : HMODULE -> Pointer<Void>
// lpDllName : LPCSTR -> Pointer<Utf8>
// lpProcName : LPCSTR -> Pointer<Utf8>
// Reserved : DWORD optional -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function QueryOptionalDelayLoadedAPI(
  hParentModule: THandle;   // HMODULE
  lpDllName: PAnsiChar;   // LPCSTR
  lpProcName: PAnsiChar;   // LPCSTR
  Reserved: DWORD   // DWORD optional
): BOOL; stdcall;
  external 'api-ms-win-core-libraryloader-l2-1-0.dll' name 'QueryOptionalDelayLoadedAPI';

import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "QueryOptionalDelayLoadedAPI"
  c_QueryOptionalDelayLoadedAPI :: Ptr () -> CString -> CString -> Word32 -> IO CInt
-- hParentModule : HMODULE -> Ptr ()
-- lpDllName : LPCSTR -> CString
-- lpProcName : LPCSTR -> CString
-- Reserved : DWORD optional -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。

open Ctypes
open Foreign

let queryoptionaldelayloadedapi =
  foreign "QueryOptionalDelayLoadedAPI"
    ((ptr void) @-> string @-> string @-> uint32_t @-> returning int32_t)
(* hParentModule : HMODULE -> (ptr void) *)
(* lpDllName : LPCSTR -> string *)
(* lpProcName : LPCSTR -> string *)
(* Reserved : DWORD optional -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)

(cffi:define-foreign-library api-ms-win-core-libraryloader-l2-1-0 (t "api-ms-win-core-libraryloader-l2-1-0.dll"))
(cffi:use-foreign-library api-ms-win-core-libraryloader-l2-1-0)

(cffi:defcfun ("QueryOptionalDelayLoadedAPI" query-optional-delay-loaded-api :convention :stdcall) :int32
  (h-parent-module :pointer)   ; HMODULE
  (lp-dll-name :string)   ; LPCSTR
  (lp-proc-name :string)   ; LPCSTR
  (reserved :uint32))   ; DWORD optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $QueryOptionalDelayLoadedAPI = Win32::API::More->new('api-ms-win-core-libraryloader-l2-1-0',
    'BOOL QueryOptionalDelayLoadedAPI(HANDLE hParentModule, LPCSTR lpDllName, LPCSTR lpProcName, DWORD Reserved)');
# my $ret = $QueryOptionalDelayLoadedAPI->Call($hParentModule, $lpDllName, $lpProcName, $Reserved);
# hParentModule : HMODULE -> HANDLE
# lpDllName : LPCSTR -> LPCSTR
# lpProcName : LPCSTR -> LPCSTR
# Reserved : DWORD optional -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。