ホーム › System.ApplicationInstallationAndServicing › MsiOpenPackageExA

MsiOpenPackageExA

関数

オプションを指定してインストールパッケージを開きハンドルを取得する。

DLLmsi.dll文字セットANSI (-A)呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD MsiOpenPackageExA(
    LPCSTR szPackagePath,
    DWORD dwOptions,
    MSIHANDLE* hProduct
);

パラメーター

名前

型

方向

説明

szPackagePath

LPCSTR

パッケージへのパス。

dwOptions

DWORD

コンピューターの状態を無視するかどうかを示すビットフラグ。 MsiOpenPackage の動作を使用するには 0(ゼロ)を渡します。

定数	意味
MSIOPENPACKAGEFLAGS_IGNOREMACHINESTATE 1	製品ハンドルを作成する際にコンピューターの状態を無視します。

hProduct

MSIHANDLE*

out

製品ハンドルを受け取る変数へのポインター。

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

この関数が失敗した場合、システムエラーコードを返すことがあります。詳細については、システムエラーコードを参照してください。

解説(Remarks)

現在のマシンの状態に依存せず、かつ現在のマシンの状態を変更できない、制限された製品ハンドルを作成するには、dwOptions に MSIOPENPACKAGEFLAGS_IGNOREMACHINESTATE を設定して MsiOpenPackageEx を使用します。

dwOptions が MSIOPENPACKAGEFLAGS_IGNOREMACHINESTATE または 1 の場合、 MsiOpenPackageEx は製品ハンドルを作成する際に現在のマシンの状態を無視することに注意してください。dwOptions の値が 0 の場合、 MsiOpenPackageEx は MsiOpenPackage と同じであり、szPackagePath で指定されたパッケージがコンピューターに既にインストールされているかどうかに依存する製品ハンドルを作成します。

MSIOPENPACKAGEFLAGS_IGNOREMACHINESTATE を指定して MsiOpenPackageEx を使用することで作成される制限されたハンドルでは、ダイアログの実行、標準アクションのサブセット、およびプロパティを設定するカスタムアクション( Custom Action Type 35、 Custom Action Type 51、 Custom Action Type 19)のみが許可されます。この制限されたハンドルでは、 Dynamic-Link Libraries、 Executable Files、または Scripts を実行するカスタムアクションの使用が禁止されます。

制限されたハンドルを使用して、次の標準アクションに対して MsiDoAction を呼び出すことができます。その他のすべてのアクションは、制限されたハンドルで呼び出された場合に ERROR_FUNCTION_NOT_CALLED を返します。

ハンドルが不要になったときは、 MsiCloseHandle 関数を呼び出す必要があります。

メモ

msi.h ヘッダーは MsiOpenPackageEx を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じ、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 MsiOpenPackageExA(
    LPCSTR szPackagePath,
    DWORD dwOptions,
    MSIHANDLE* hProduct
);

[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiOpenPackageExA(
    [MarshalAs(UnmanagedType.LPStr)] string szPackagePath,   // LPCSTR
    uint dwOptions,   // DWORD
    out uint hProduct   // MSIHANDLE* out
);

<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiOpenPackageExA(
    <MarshalAs(UnmanagedType.LPStr)> szPackagePath As String,   ' LPCSTR
    dwOptions As UInteger,   ' DWORD
    <Out> ByRef hProduct As UInteger   ' MSIHANDLE* out
) As UInteger
End Function

' szPackagePath : LPCSTR
' dwOptions : DWORD
' hProduct : MSIHANDLE* out
Declare PtrSafe Function MsiOpenPackageExA Lib "msi" ( _
    ByVal szPackagePath As String, _
    ByVal dwOptions As Long, _
    ByRef hProduct As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MsiOpenPackageExA = ctypes.windll.msi.MsiOpenPackageExA
MsiOpenPackageExA.restype = wintypes.DWORD
MsiOpenPackageExA.argtypes = [
    wintypes.LPCSTR,  # szPackagePath : LPCSTR
    wintypes.DWORD,  # dwOptions : DWORD
    ctypes.c_void_p,  # hProduct : MSIHANDLE* out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiOpenPackageExA = Fiddle::Function.new(
  lib['MsiOpenPackageExA'],
  [
    Fiddle::TYPE_VOIDP,  # szPackagePath : LPCSTR
    -Fiddle::TYPE_INT,  # dwOptions : DWORD
    Fiddle::TYPE_VOIDP,  # hProduct : MSIHANDLE* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "msi")]
extern "system" {
    fn MsiOpenPackageExA(
        szPackagePath: *const u8,  // LPCSTR
        dwOptions: u32,  // DWORD
        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 MsiOpenPackageExA([MarshalAs(UnmanagedType.LPStr)] string szPackagePath, uint dwOptions, out uint hProduct);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiOpenPackageExA' -Namespace Win32 -PassThru
# $api::MsiOpenPackageExA(szPackagePath, dwOptions, hProduct)

#uselib "msi.dll"
#func global MsiOpenPackageExA "MsiOpenPackageExA" sptr, sptr, sptr
; MsiOpenPackageExA szPackagePath, dwOptions, varptr(hProduct)   ; 戻り値は stat
; szPackagePath : LPCSTR -> "sptr"
; dwOptions : DWORD -> "sptr"
; hProduct : MSIHANDLE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "msi.dll"
#cfunc global MsiOpenPackageExA "MsiOpenPackageExA" str, int, var
; res = MsiOpenPackageExA(szPackagePath, dwOptions, hProduct)
; szPackagePath : LPCSTR -> "str"
; dwOptions : DWORD -> "int"
; hProduct : MSIHANDLE* out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "msi.dll"
#cfunc global MsiOpenPackageExA "MsiOpenPackageExA" str, int, sptr
; res = MsiOpenPackageExA(szPackagePath, dwOptions, varptr(hProduct))
; szPackagePath : LPCSTR -> "str"
; dwOptions : DWORD -> "int"
; hProduct : MSIHANDLE* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。