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

LoadPackagedLibrary

関数
パッケージアプリ用のDLLを読み込む。
DLLKERNEL32.dll呼出規約winapiSetLastErrorあり対応OSwindows8.0

シグネチャ

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

HMODULE LoadPackagedLibrary(
    LPCWSTR lpwLibFileName,
    DWORD Reserved   // optional
);

パラメーター

名前方向説明
lpwLibFileNameLPCWSTRin

読み込むパッケージ化されたモジュールのファイル名。モジュールはライブラリモジュール(.dll ファイル)または実行可能モジュール(.exe ファイル)のいずれかです。

このパラメーターでパスを含まないモジュール名を指定し、ファイル名拡張子を省略した場合、関数はモジュール名に既定のライブラリ拡張子 .dll を付加します。関数がモジュール名に .dll を付加しないようにするには、モジュール名文字列の末尾にピリオド文字(.)を含めます。

このパラメーターでパスを指定した場合、関数はそのパスでモジュールを検索します。パスは絶対パス、またはパス内に ".." を含む相対パスにはできません。 パスを指定する際は、スラッシュ(/)ではなくバックスラッシュ(\)を使用してください。パスの詳細については、ファイル、パス、および名前空間の名前付けを参照してください。

指定したモジュールがプロセス内に既に読み込まれている場合、関数は読み込み済みモジュールのハンドルを返します。そのモジュールは、元々プロセスのパッケージ依存関係グラフから読み込まれたものでなければなりません。

指定したモジュールの読み込みによってシステムが他の関連モジュールを読み込む場合、関数はまず読み込み済みのモジュールを検索し、次にプロセスのパッケージ依存関係グラフを検索します。 詳細については、「解説」を参照してください。

ReservedDWORDoptionalこのパラメーターは予約されています。0 でなければなりません。

戻り値の型: HMODULE

公式ドキュメント

指定されたパッケージ化されたモジュールとその依存モジュールを、呼び出し元プロセスのアドレス空間に読み込みます。

戻り値

関数が成功した場合、戻り値は読み込まれたモジュールのハンドルです。

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

解説(Remarks)

LoadPackagedLibrary 関数は LoadLibraryEx の簡易版です。パッケージ化されたアプリは LoadPackagedLibrary を使用してパッケージ化されたモジュールを読み込むことができます。パッケージ化されていないアプリケーションは LoadPackagedLibrary を使用できません。パッケージ化されていないアプリケーションがこの関数を呼び出した場合、APPMODEL_ERROR_NO_PACKAGE で失敗します。

LoadPackagedLibrary は指定したモジュールのハンドルを返し、その参照カウントをインクリメントします。モジュールが既に読み込まれている場合、関数は読み込み済みモジュールのハンドルを返します。呼び出し元プロセスは、LoadPackagedLibrary が返したハンドルを使用して、 GetProcAddress 関数の呼び出しでモジュールを識別できます。読み込まれたモジュールを解放し、その参照カウントをデクリメントするには、FreeLibrary 関数を使用します。

関数が指定したモジュールまたはその依存関係を検索しなければならない場合、検索対象はプロセスのパッケージ依存関係グラフのみです。 これはアプリケーションのパッケージに加え、アプリケーションのパッケージマニフェストの <Dependencies> セクションで <PackageDependency> として指定された依存関係を含みます。依存関係はマニフェストに現れる順序で検索されます。パッケージ依存関係グラフは、アプリケーションのパッケージマニフェストの <Dependencies> セクションで指定されます。依存関係はマニフェストに現れる順序で検索されます。検索は次のように進行します。

  1. 関数はまず、既に読み込まれているモジュールを検索します。指定したモジュールが元々プロセスのパッケージ依存関係グラフから読み込まれたものである場合、関数は読み込み済みモジュールのハンドルを返します。指定したモジュールがプロセスのパッケージ依存関係グラフから読み込まれたものでない場合、関数は NULL を返します。
  2. モジュールがまだ読み込まれていない場合、関数はプロセスのパッケージ依存関係グラフを検索します。
  3. 関数が指定したモジュールまたはその依存関係の 1 つを見つけられない場合、関数は失敗します。

DllMain から LoadPackagedLibrary を呼び出すのは安全ではありません。詳細については、 DllMain の「解説」セクションを参照してください。

メモ

Windows Phone では、LoadPackagedLibraryPhoneAppModelHost.dll から呼び出す必要があります。Kernel32.dll の使用はサポートされていません。

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

各言語での呼び出し定義

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

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

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

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

var (
	kernel32 = windows.NewLazySystemDLL("KERNEL32.dll")
	procLoadPackagedLibrary = kernel32.NewProc("LoadPackagedLibrary")
)

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

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

typedef LoadPackagedLibraryNative = Pointer<Void> Function(Pointer<Utf16>, Uint32);
typedef LoadPackagedLibraryDart = Pointer<Void> Function(Pointer<Utf16>, int);
final LoadPackagedLibrary = DynamicLibrary.open('KERNEL32.dll')
    .lookupFunction<LoadPackagedLibraryNative, LoadPackagedLibraryDart>('LoadPackagedLibrary');
// lpwLibFileName : LPCWSTR -> Pointer<Utf16>
// Reserved : DWORD optional -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function LoadPackagedLibrary(
  lpwLibFileName: PWideChar;   // LPCWSTR
  Reserved: DWORD   // DWORD optional
): THandle; stdcall;
  external 'KERNEL32.dll' name 'LoadPackagedLibrary';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

(cffi:defcfun ("LoadPackagedLibrary" load-packaged-library :convention :stdcall) :pointer
  (lpw-lib-file-name (:string :encoding :utf-16le))   ; LPCWSTR
  (reserved :uint32))   ; DWORD optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $LoadPackagedLibrary = Win32::API::More->new('KERNEL32',
    'HANDLE LoadPackagedLibrary(LPCWSTR lpwLibFileName, DWORD Reserved)');
# my $ret = $LoadPackagedLibrary->Call($lpwLibFileName, $Reserved);
# lpwLibFileName : LPCWSTR -> LPCWSTR
# Reserved : DWORD optional -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。