ホーム › System.ApplicationInstallationAndServicing › MsiOpenPackageW
MsiOpenPackageW
関数インストールパッケージを開いてインストールセッションのハンドルを取得する。
シグネチャ
// msi.dll (Unicode / -W)
#include <windows.h>
DWORD MsiOpenPackageW(
LPCWSTR szPackagePath,
MSIHANDLE* hProduct
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| szPackagePath | LPCWSTR | in | パッケージへのパス。 |
| hProduct | MSIHANDLE* | out | 製品ハンドルを受け取る変数へのポインター。 |
戻り値の型: DWORD
公式ドキュメント
MsiOpenPackage 関数は、製品データベースにアクセスする関数で使用するためにパッケージを開きます。(Unicode)
戻り値
| 値 | 意味 |
|---|---|
| 構成情報が破損しています。 | |
| 製品を開けませんでした。 | |
| Windows Installer はリモート デスクトップ接続からのインストールを許可しません。 | |
| 無効なパラメーターが関数に渡されました。 | |
| 関数は正常に完了しました。 |
この関数が失敗した場合、システム エラー コードを返すことがあります。詳細については、 System Error Codes を参照してください。
解説(Remarks)
MsiOpenPackage は、パッケージへのパスの代わりに、"#nnnn" の形式(nnnn は文字列形式のデータベース ハンドル、すなわち #123)で開かれたデータベース ハンドルを受け取ることができます。これは、検証アクションの実行などの開発作業や、データベース管理ツールでの使用を意図しています。
メモ
msi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして MsiOpenPackage を定義します。エンコード ニュートラルなエイリアスを、エンコード ニュートラルではないコードと混在して使用すると、不一致が生じてコンパイル エラーまたは実行時エラーが発生する可能性があります。詳細については、Conventions for Function Prototypes を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// msi.dll (Unicode / -W)
#include <windows.h>
DWORD MsiOpenPackageW(
LPCWSTR szPackagePath,
MSIHANDLE* hProduct
);[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiOpenPackageW(
[MarshalAs(UnmanagedType.LPWStr)] string szPackagePath, // LPCWSTR
out uint hProduct // MSIHANDLE* out
);<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiOpenPackageW(
<MarshalAs(UnmanagedType.LPWStr)> szPackagePath As String, ' LPCWSTR
<Out> ByRef hProduct As UInteger ' MSIHANDLE* out
) As UInteger
End Function' szPackagePath : LPCWSTR
' hProduct : MSIHANDLE* out
Declare PtrSafe Function MsiOpenPackageW Lib "msi" ( _
ByVal szPackagePath As LongPtr, _
ByRef hProduct As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
MsiOpenPackageW = ctypes.windll.msi.MsiOpenPackageW
MsiOpenPackageW.restype = wintypes.DWORD
MsiOpenPackageW.argtypes = [
wintypes.LPCWSTR, # szPackagePath : LPCWSTR
ctypes.c_void_p, # hProduct : MSIHANDLE* out
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('msi.dll')
MsiOpenPackageW = Fiddle::Function.new(
lib['MsiOpenPackageW'],
[
Fiddle::TYPE_VOIDP, # szPackagePath : LPCWSTR
Fiddle::TYPE_VOIDP, # hProduct : MSIHANDLE* out
],
-Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "msi")]
extern "system" {
fn MsiOpenPackageW(
szPackagePath: *const u16, // LPCWSTR
hProduct: *mut u32 // MSIHANDLE* out
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Unicode)]
public static extern uint MsiOpenPackageW([MarshalAs(UnmanagedType.LPWStr)] string szPackagePath, out uint hProduct);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiOpenPackageW' -Namespace Win32 -PassThru
# $api::MsiOpenPackageW(szPackagePath, hProduct)#uselib "msi.dll"
#func global MsiOpenPackageW "MsiOpenPackageW" wptr, wptr
; MsiOpenPackageW szPackagePath, varptr(hProduct) ; 戻り値は stat
; szPackagePath : LPCWSTR -> "wptr"
; hProduct : MSIHANDLE* out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。出力引数:
#uselib "msi.dll" #cfunc global MsiOpenPackageW "MsiOpenPackageW" wstr, var ; res = MsiOpenPackageW(szPackagePath, hProduct) ; szPackagePath : LPCWSTR -> "wstr" ; hProduct : MSIHANDLE* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "msi.dll" #cfunc global MsiOpenPackageW "MsiOpenPackageW" wstr, sptr ; res = MsiOpenPackageW(szPackagePath, varptr(hProduct)) ; szPackagePath : LPCWSTR -> "wstr" ; hProduct : MSIHANDLE* out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
出力引数:
; DWORD MsiOpenPackageW(LPCWSTR szPackagePath, MSIHANDLE* hProduct) #uselib "msi.dll" #cfunc global MsiOpenPackageW "MsiOpenPackageW" wstr, var ; res = MsiOpenPackageW(szPackagePath, hProduct) ; szPackagePath : LPCWSTR -> "wstr" ; hProduct : MSIHANDLE* out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD MsiOpenPackageW(LPCWSTR szPackagePath, MSIHANDLE* hProduct) #uselib "msi.dll" #cfunc global MsiOpenPackageW "MsiOpenPackageW" wstr, intptr ; res = MsiOpenPackageW(szPackagePath, varptr(hProduct)) ; szPackagePath : LPCWSTR -> "wstr" ; hProduct : MSIHANDLE* out -> "intptr" ; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。
import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
msi = windows.NewLazySystemDLL("msi.dll")
procMsiOpenPackageW = msi.NewProc("MsiOpenPackageW")
)
// szPackagePath (LPCWSTR), hProduct (MSIHANDLE* out)
r1, _, err := procMsiOpenPackageW.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szPackagePath))),
uintptr(hProduct),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction MsiOpenPackageW(
szPackagePath: PWideChar; // LPCWSTR
hProduct: Pointer // MSIHANDLE* out
): DWORD; stdcall;
external 'msi.dll' name 'MsiOpenPackageW';result := DllCall("msi\MsiOpenPackageW"
, "WStr", szPackagePath ; LPCWSTR
, "Ptr", hProduct ; MSIHANDLE* out
, "UInt") ; return: DWORD●MsiOpenPackageW(szPackagePath, hProduct) = DLL("msi.dll", "dword MsiOpenPackageW(char*, void*)")
# 呼び出し: MsiOpenPackageW(szPackagePath, hProduct)
# szPackagePath : LPCWSTR -> "char*"
# hProduct : MSIHANDLE* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "msi" fn MsiOpenPackageW(
szPackagePath: [*c]const u16, // LPCWSTR
hProduct: [*c]u32 // MSIHANDLE* out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc MsiOpenPackageW(
szPackagePath: WideCString, # LPCWSTR
hProduct: ptr uint32 # MSIHANDLE* out
): uint32 {.importc: "MsiOpenPackageW", stdcall, dynlib: "msi.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "msi");
extern(Windows)
uint MsiOpenPackageW(
const(wchar)* szPackagePath, // LPCWSTR
uint* hProduct // MSIHANDLE* out
);ccall((:MsiOpenPackageW, "msi.dll"), stdcall, UInt32,
(Cwstring, Ptr{UInt32}),
szPackagePath, hProduct)
# szPackagePath : LPCWSTR -> Cwstring
# hProduct : MSIHANDLE* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiOpenPackageW(
const uint16_t* szPackagePath,
uint32_t* hProduct);
]]
local msi = ffi.load("msi")
-- msi.MsiOpenPackageW(szPackagePath, hProduct)
-- szPackagePath : LPCWSTR
-- hProduct : MSIHANDLE* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiOpenPackageW = lib.func('__stdcall', 'MsiOpenPackageW', 'uint32_t', ['str16', 'uint32_t *']);
// MsiOpenPackageW(szPackagePath, hProduct)
// szPackagePath : LPCWSTR -> 'str16'
// hProduct : MSIHANDLE* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("msi.dll", {
MsiOpenPackageW: { parameters: ["buffer", "pointer"], result: "u32" },
});
// lib.symbols.MsiOpenPackageW(szPackagePath, hProduct)
// szPackagePath : LPCWSTR -> "buffer"
// hProduct : MSIHANDLE* out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiOpenPackageW(
const uint16_t* szPackagePath,
uint32_t* hProduct);
C, "msi.dll");
// $ffi->MsiOpenPackageW(szPackagePath, hProduct);
// szPackagePath : LPCWSTR
// hProduct : MSIHANDLE* out
// 構造体/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 Msi extends StdCallLibrary {
Msi INSTANCE = Native.load("msi", Msi.class, W32APIOptions.UNICODE_OPTIONS);
int MsiOpenPackageW(
WString szPackagePath, // LPCWSTR
IntByReference hProduct // MSIHANDLE* out
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("msi")]
lib Libmsi
fun MsiOpenPackageW = MsiOpenPackageW(
szPackagePath : UInt16*, # LPCWSTR
hProduct : UInt32* # MSIHANDLE* out
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef MsiOpenPackageWNative = Uint32 Function(Pointer<Utf16>, Pointer<Uint32>);
typedef MsiOpenPackageWDart = int Function(Pointer<Utf16>, Pointer<Uint32>);
final MsiOpenPackageW = DynamicLibrary.open('msi.dll')
.lookupFunction<MsiOpenPackageWNative, MsiOpenPackageWDart>('MsiOpenPackageW');
// szPackagePath : LPCWSTR -> Pointer<Utf16>
// hProduct : MSIHANDLE* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function MsiOpenPackageW(
szPackagePath: PWideChar; // LPCWSTR
hProduct: Pointer // MSIHANDLE* out
): DWORD; stdcall;
external 'msi.dll' name 'MsiOpenPackageW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "MsiOpenPackageW"
c_MsiOpenPackageW :: CWString -> Ptr Word32 -> IO Word32
-- szPackagePath : LPCWSTR -> CWString
-- hProduct : MSIHANDLE* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let msiopenpackagew =
foreign "MsiOpenPackageW"
((ptr uint16_t) @-> (ptr uint32_t) @-> returning uint32_t)
(* szPackagePath : LPCWSTR -> (ptr uint16_t) *)
(* hProduct : MSIHANDLE* out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)
(cffi:defcfun ("MsiOpenPackageW" msi-open-package-w :convention :stdcall) :uint32
(sz-package-path (:string :encoding :utf-16le)) ; LPCWSTR
(h-product :pointer)) ; MSIHANDLE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $MsiOpenPackageW = Win32::API::More->new('msi',
'DWORD MsiOpenPackageW(LPCWSTR szPackagePath, LPVOID hProduct)');
# my $ret = $MsiOpenPackageW->Call($szPackagePath, $hProduct);
# szPackagePath : LPCWSTR -> LPCWSTR
# hProduct : MSIHANDLE* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
文字セット違い
- f MsiOpenPackageA (ANSI版) — インストールパッケージを開いてインストールセッションのハンドルを取得する。
類似 API
- f MsiOpenPackageExW — オプションを指定してインストールパッケージを開きハンドルを取得する。