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

MsiOpenPackageA

関数
インストールパッケージを開いてインストールセッションのハンドルを取得する。
DLLmsi.dll文字セットANSI (-A)呼出規約winapi対応OSwindows8.0
📘 Microsoft Learn (日本語) · English

シグネチャ

// msi.dll  (ANSI / -A)
#include <windows.h>

DWORD MsiOpenPackageA(
    LPCSTR szPackagePath,
    MSIHANDLE* hProduct
);

パラメーター

名前型方向説明
szPackagePathLPCSTRinパッケージへのパス。
hProductMSIHANDLE*out製品ハンドルを受け取る変数へのポインター。

戻り値の型: DWORD

公式ドキュメント

MsiOpenPackage 関数は、製品データベースにアクセスする関数で使用するためにパッケージを開きます。(ANSI)

戻り値

値 意味
ERROR_BAD_CONFIGURATION
 構成情報が破損しています。
ERROR_INSTALL_FAILURE
 製品を開くことができませんでした。
ERROR_INSTALL_REMOTE_PROHIBITED
 Windows Installer はリモートデスクトップ接続からのインストールを許可しません。
ERROR_INVALID_PARAMETER
 無効なパラメーターが関数に渡されました。
ERROR_SUCCESS
 関数が正常に完了しました。

この関数が失敗した場合、システムエラーコードが返されることがあります。詳細については、 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)

各言語での呼び出し定義

// msi.dll  (ANSI / -A)
#include <windows.h>

DWORD MsiOpenPackageA(
    LPCSTR szPackagePath,
    MSIHANDLE* hProduct
);
[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiOpenPackageA(
    [MarshalAs(UnmanagedType.LPStr)] string szPackagePath,   // LPCSTR
    out uint hProduct   // MSIHANDLE* out
);
<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiOpenPackageA(
    <MarshalAs(UnmanagedType.LPStr)> szPackagePath As String,   ' LPCSTR
    <Out> ByRef hProduct As UInteger   ' MSIHANDLE* out
) As UInteger
End Function
' szPackagePath : LPCSTR
' hProduct : MSIHANDLE* out
Declare PtrSafe Function MsiOpenPackageA Lib "msi" ( _
    ByVal szPackagePath As String, _
    ByRef hProduct As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MsiOpenPackageA = ctypes.windll.msi.MsiOpenPackageA
MsiOpenPackageA.restype = wintypes.DWORD
MsiOpenPackageA.argtypes = [
    wintypes.LPCSTR,  # szPackagePath : LPCSTR
    ctypes.c_void_p,  # hProduct : MSIHANDLE* out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiOpenPackageA = Fiddle::Function.new(
  lib['MsiOpenPackageA'],
  [
    Fiddle::TYPE_VOIDP,  # szPackagePath : LPCSTR
    Fiddle::TYPE_VOIDP,  # hProduct : MSIHANDLE* out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "msi")]
extern "system" {
    fn MsiOpenPackageA(
        szPackagePath: *const u8,  // LPCSTR
        hProduct: *mut u32  // MSIHANDLE* out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Ansi)]
public static extern uint MsiOpenPackageA([MarshalAs(UnmanagedType.LPStr)] string szPackagePath, out uint hProduct);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiOpenPackageA' -Namespace Win32 -PassThru
# $api::MsiOpenPackageA(szPackagePath, hProduct)
#uselib "msi.dll"
#func global MsiOpenPackageA "MsiOpenPackageA" sptr, sptr
; MsiOpenPackageA szPackagePath, varptr(hProduct)   ; 戻り値は stat
; szPackagePath : LPCSTR -> "sptr"
; hProduct : MSIHANDLE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "msi.dll"
#cfunc global MsiOpenPackageA "MsiOpenPackageA" str, var
; res = MsiOpenPackageA(szPackagePath, hProduct)
; szPackagePath : LPCSTR -> "str"
; hProduct : MSIHANDLE* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; DWORD MsiOpenPackageA(LPCSTR szPackagePath, MSIHANDLE* hProduct)
#uselib "msi.dll"
#cfunc global MsiOpenPackageA "MsiOpenPackageA" str, var
; res = MsiOpenPackageA(szPackagePath, hProduct)
; szPackagePath : LPCSTR -> "str"
; hProduct : MSIHANDLE* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiOpenPackageA = msi.NewProc("MsiOpenPackageA")
)

// szPackagePath (LPCSTR), hProduct (MSIHANDLE* out)
r1, _, err := procMsiOpenPackageA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(szPackagePath))),
	uintptr(hProduct),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function MsiOpenPackageA(
  szPackagePath: PAnsiChar;   // LPCSTR
  hProduct: Pointer   // MSIHANDLE* out
): DWORD; stdcall;
  external 'msi.dll' name 'MsiOpenPackageA';
result := DllCall("msi\MsiOpenPackageA"
    , "AStr", szPackagePath   ; LPCSTR
    , "Ptr", hProduct   ; MSIHANDLE* out
    , "UInt")   ; return: DWORD
●MsiOpenPackageA(szPackagePath, hProduct) = DLL("msi.dll", "dword MsiOpenPackageA(char*, void*)")
# 呼び出し: MsiOpenPackageA(szPackagePath, hProduct)
# szPackagePath : LPCSTR -> "char*"
# hProduct : MSIHANDLE* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "msi" fn MsiOpenPackageA(
    szPackagePath: [*c]const u8, // LPCSTR
    hProduct: [*c]u32 // MSIHANDLE* out
) callconv(std.os.windows.WINAPI) u32;
proc MsiOpenPackageA(
    szPackagePath: cstring,  # LPCSTR
    hProduct: ptr uint32  # MSIHANDLE* out
): uint32 {.importc: "MsiOpenPackageA", stdcall, dynlib: "msi.dll".}
pragma(lib, "msi");
extern(Windows)
uint MsiOpenPackageA(
    const(char)* szPackagePath,   // LPCSTR
    uint* hProduct   // MSIHANDLE* out
);
ccall((:MsiOpenPackageA, "msi.dll"), stdcall, UInt32,
      (Cstring, Ptr{UInt32}),
      szPackagePath, hProduct)
# szPackagePath : LPCSTR -> Cstring
# hProduct : MSIHANDLE* out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiOpenPackageA(
    const char* szPackagePath,
    uint32_t* hProduct);
]]
local msi = ffi.load("msi")
-- msi.MsiOpenPackageA(szPackagePath, hProduct)
-- szPackagePath : LPCSTR
-- hProduct : MSIHANDLE* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiOpenPackageA = lib.func('__stdcall', 'MsiOpenPackageA', 'uint32_t', ['str', 'uint32_t *']);
// MsiOpenPackageA(szPackagePath, hProduct)
// szPackagePath : LPCSTR -> 'str'
// hProduct : MSIHANDLE* out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("msi.dll", {
  MsiOpenPackageA: { parameters: ["buffer", "pointer"], result: "u32" },
});
// lib.symbols.MsiOpenPackageA(szPackagePath, hProduct)
// szPackagePath : LPCSTR -> "buffer"
// hProduct : MSIHANDLE* out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiOpenPackageA(
    const char* szPackagePath,
    uint32_t* hProduct);
C, "msi.dll");
// $ffi->MsiOpenPackageA(szPackagePath, hProduct);
// szPackagePath : LPCSTR
// 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.ASCII_OPTIONS);
    int MsiOpenPackageA(
        String szPackagePath,   // LPCSTR
        IntByReference hProduct   // MSIHANDLE* out
    );
}
@[Link("msi")]
lib Libmsi
  fun MsiOpenPackageA = MsiOpenPackageA(
    szPackagePath : UInt8*,   # LPCSTR
    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 MsiOpenPackageANative = Uint32 Function(Pointer<Utf8>, Pointer<Uint32>);
typedef MsiOpenPackageADart = int Function(Pointer<Utf8>, Pointer<Uint32>);
final MsiOpenPackageA = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiOpenPackageANative, MsiOpenPackageADart>('MsiOpenPackageA');
// szPackagePath : LPCSTR -> Pointer<Utf8>
// hProduct : MSIHANDLE* out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiOpenPackageA(
  szPackagePath: PAnsiChar;   // LPCSTR
  hProduct: Pointer   // MSIHANDLE* out
): DWORD; stdcall;
  external 'msi.dll' name 'MsiOpenPackageA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiOpenPackageA"
  c_MsiOpenPackageA :: CString -> Ptr Word32 -> IO Word32
-- szPackagePath : LPCSTR -> CString
-- hProduct : MSIHANDLE* out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msiopenpackagea =
  foreign "MsiOpenPackageA"
    (string @-> (ptr uint32_t) @-> returning uint32_t)
(* szPackagePath : LPCSTR -> string *)
(* 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 ("MsiOpenPackageA" msi-open-package-a :convention :stdcall) :uint32
  (sz-package-path :string)   ; LPCSTR
  (h-product :pointer))   ; MSIHANDLE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiOpenPackageA = Win32::API::More->new('msi',
    'DWORD MsiOpenPackageA(LPCSTR szPackagePath, LPVOID hProduct)');
# my $ret = $MsiOpenPackageA->Call($szPackagePath, $hProduct);
# szPackagePath : LPCSTR -> LPCSTR
# hProduct : MSIHANDLE* out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
類似 API