ホーム › System.ApplicationInstallationAndServicing › MsiOpenDatabaseA

MsiOpenDatabaseA

関数

インストールデータベースを指定の永続モードで開く。

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

シグネチャ

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

DWORD MsiOpenDatabaseA(
    LPCSTR szDatabasePath,
    LPCSTR szPersist,
    MSIHANDLE* phDatabase
);

パラメーター

名前

型

方向

説明

szDatabasePath

LPCSTR

データベースファイルへのフルパスまたは相対パスを指定します。

szPersist

LPCSTR

ファイルへのフルパス、または永続化モードを受け取ります。szPersist パラメーターを使用して、永続的な出力を新しいファイルに振り向けるか、次の定義済み永続化モードのいずれかを指定できます。

値	意味
MSIDBOPEN_CREATEDIRECT	新しいデータベースを作成します。ダイレクトモードの読み取り/書き込みです。
MSIDBOPEN_CREATE	新しいデータベースを作成します。トランザクションモードの読み取り/書き込みです。
MSIDBOPEN_DIRECT	トランザクションを使用せず、データベースをダイレクトな読み取り/書き込みで開きます。
MSIDBOPEN_READONLY	データベースを読み取り専用で開きます。永続的な変更は行われません。
MSIDBOPEN_TRANSACT	データベースをトランザクションモードの読み取り/書き込みで開きます。
MSIDBOPEN_PATCHFILE	パッチファイルであることを示すには、このフラグを追加します。

phDatabase

MSIHANDLE*

inout

返されるデータベースハンドルの格納先へのポインターです。

戻り値の型: DWORD

公式ドキュメント

MsiOpenDatabase 関数は、データアクセスのためにデータベースファイルを開きます。この関数は、MsiCloseHandle を使用して閉じる必要があるハンドルを返します。(ANSI)

戻り値

MsiOpenDatabase 関数は、次の値を返します。

解説(Remarks)

データベースに変更を加えて保存するには、まずデータベースをトランザクション (MSIDBOPEN_TRANSACT)、作成 (MSIDBOPEN_CREATE または MSIDBOPEN_CREATEDIRECT)、またはダイレクト (MSIDBOPEN_DIRECT) モードで開きます。変更を加えた後は、データベースハンドルを閉じる前に必ず MsiDatabaseCommit を呼び出してください。 MsiDatabaseCommit はすべてのバッファーをフラッシュします。

ダイレクトモード (MSIDBOPEN_DIRECT または MSIDBOPEN_CREATEDIRECT) で開いたデータベースに対しては、ハンドルを閉じる前に必ず MsiDatabaseCommit を呼び出してください。これを怠ると、データベースが破損する可能性があります。

MsiOpenDatabase はデータベースアクセスを開始するため、実行中のインストールでは使用できません。

インストーラーは PMSIHANDLE オブジェクトがスコープ外になると自動的に閉じますが、MSIHANDLE オブジェクトは MsiCloseHandle を呼び出して閉じる必要があるため、PMSIHANDLE 型の変数を使用することを推奨します。詳細については、Windows インストーラーのベストプラクティスの HANDLE の代わりに PMSIHANDLE を使用するのセクションを参照してください。

注意データベースが別のデータベースの出力として開かれる場合、出力データベースの概要情報ストリームは実際には元のデータベースの読み取り専用のミラーであるため、変更できません。さらに、これはデータベースとともに永続化されません。出力データベースの概要情報を作成または変更するには、データベースを一度閉じてから開き直す必要があります。

関数が失敗した場合は、MsiGetLastErrorRecord を使用して拡張エラー情報を取得できます。

メモ

msiquery.h ヘッダーは、MsiOpenDatabase を、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 MsiOpenDatabaseA(
    LPCSTR szDatabasePath,
    LPCSTR szPersist,
    MSIHANDLE* phDatabase
);

[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiOpenDatabaseA(
    [MarshalAs(UnmanagedType.LPStr)] string szDatabasePath,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string szPersist,   // LPCSTR
    ref uint phDatabase   // MSIHANDLE* in/out
);

<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiOpenDatabaseA(
    <MarshalAs(UnmanagedType.LPStr)> szDatabasePath As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> szPersist As String,   ' LPCSTR
    ByRef phDatabase As UInteger   ' MSIHANDLE* in/out
) As UInteger
End Function

' szDatabasePath : LPCSTR
' szPersist : LPCSTR
' phDatabase : MSIHANDLE* in/out
Declare PtrSafe Function MsiOpenDatabaseA Lib "msi" ( _
    ByVal szDatabasePath As String, _
    ByVal szPersist As String, _
    ByRef phDatabase As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MsiOpenDatabaseA = ctypes.windll.msi.MsiOpenDatabaseA
MsiOpenDatabaseA.restype = wintypes.DWORD
MsiOpenDatabaseA.argtypes = [
    wintypes.LPCSTR,  # szDatabasePath : LPCSTR
    wintypes.LPCSTR,  # szPersist : LPCSTR
    ctypes.c_void_p,  # phDatabase : MSIHANDLE* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiOpenDatabaseA = Fiddle::Function.new(
  lib['MsiOpenDatabaseA'],
  [
    Fiddle::TYPE_VOIDP,  # szDatabasePath : LPCSTR
    Fiddle::TYPE_VOIDP,  # szPersist : LPCSTR
    Fiddle::TYPE_VOIDP,  # phDatabase : MSIHANDLE* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "msi")]
extern "system" {
    fn MsiOpenDatabaseA(
        szDatabasePath: *const u8,  // LPCSTR
        szPersist: *const u8,  // LPCSTR
        phDatabase: *mut u32  // MSIHANDLE* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Ansi)]
public static extern uint MsiOpenDatabaseA([MarshalAs(UnmanagedType.LPStr)] string szDatabasePath, [MarshalAs(UnmanagedType.LPStr)] string szPersist, ref uint phDatabase);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiOpenDatabaseA' -Namespace Win32 -PassThru
# $api::MsiOpenDatabaseA(szDatabasePath, szPersist, phDatabase)

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

出力引数:

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