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

MsiGetActiveDatabase

関数
実行中のインストールセッションのアクティブなデータベースを取得する。
DLLmsi.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

MSIHANDLE MsiGetActiveDatabase(
    MSIHANDLE hInstall
);

パラメーター

名前方向説明
hInstallMSIHANDLEinDLL カスタムアクションに提供される、または MsiOpenPackageMsiOpenPackageExMsiOpenProduct を通じて取得した、インストールへのハンドルです。

戻り値の型: MSIHANDLE

公式ドキュメント

MsiGetActiveDatabase 関数は、インストールに使用中のアクティブなデータベースを返します。この関数は読み取り専用のハンドルを返し、このハンドルは MsiCloseHandle を使用して閉じる必要があります。

戻り値

関数が成功した場合、インストーラーが現在使用しているデータベースへの読み取り専用ハンドルを返します。関数が失敗した場合は、ゼロ (0) を返します。

解説(Remarks)

MsiGetActiveDatabase 関数は、実行中のインストールが使用しているデータベースにアクセスします。

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

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

各言語での呼び出し定義

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

MSIHANDLE MsiGetActiveDatabase(
    MSIHANDLE hInstall
);
[DllImport("msi.dll", ExactSpelling = true)]
static extern uint MsiGetActiveDatabase(
    uint hInstall   // MSIHANDLE
);
<DllImport("msi.dll", ExactSpelling:=True)>
Public Shared Function MsiGetActiveDatabase(
    hInstall As UInteger   ' MSIHANDLE
) As UInteger
End Function
' hInstall : MSIHANDLE
Declare PtrSafe Function MsiGetActiveDatabase Lib "msi" ( _
    ByVal hInstall As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MsiGetActiveDatabase = ctypes.windll.msi.MsiGetActiveDatabase
MsiGetActiveDatabase.restype = wintypes.DWORD
MsiGetActiveDatabase.argtypes = [
    wintypes.DWORD,  # hInstall : MSIHANDLE
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiGetActiveDatabase = Fiddle::Function.new(
  lib['MsiGetActiveDatabase'],
  [
    -Fiddle::TYPE_INT,  # hInstall : MSIHANDLE
  ],
  -Fiddle::TYPE_INT)
#[link(name = "msi")]
extern "system" {
    fn MsiGetActiveDatabase(
        hInstall: u32  // MSIHANDLE
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("msi.dll")]
public static extern uint MsiGetActiveDatabase(uint hInstall);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiGetActiveDatabase' -Namespace Win32 -PassThru
# $api::MsiGetActiveDatabase(hInstall)
#uselib "msi.dll"
#func global MsiGetActiveDatabase "MsiGetActiveDatabase" sptr
; MsiGetActiveDatabase hInstall   ; 戻り値は stat
; hInstall : MSIHANDLE -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "msi.dll"
#cfunc global MsiGetActiveDatabase "MsiGetActiveDatabase" int
; res = MsiGetActiveDatabase(hInstall)
; hInstall : MSIHANDLE -> "int"
; MSIHANDLE MsiGetActiveDatabase(MSIHANDLE hInstall)
#uselib "msi.dll"
#cfunc global MsiGetActiveDatabase "MsiGetActiveDatabase" int
; res = MsiGetActiveDatabase(hInstall)
; hInstall : MSIHANDLE -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiGetActiveDatabase = msi.NewProc("MsiGetActiveDatabase")
)

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

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

typedef MsiGetActiveDatabaseNative = Uint32 Function(Uint32);
typedef MsiGetActiveDatabaseDart = int Function(int);
final MsiGetActiveDatabase = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiGetActiveDatabaseNative, MsiGetActiveDatabaseDart>('MsiGetActiveDatabase');
// hInstall : MSIHANDLE -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiGetActiveDatabase(
  hInstall: DWORD   // MSIHANDLE
): DWORD; stdcall;
  external 'msi.dll' name 'MsiGetActiveDatabase';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiGetActiveDatabase"
  c_MsiGetActiveDatabase :: Word32 -> IO Word32
-- hInstall : MSIHANDLE -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msigetactivedatabase =
  foreign "MsiGetActiveDatabase"
    (uint32_t @-> returning uint32_t)
(* hInstall : MSIHANDLE -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)

(cffi:defcfun ("MsiGetActiveDatabase" msi-get-active-database :convention :stdcall) :uint32
  (h-install :uint32))   ; MSIHANDLE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiGetActiveDatabase = Win32::API::More->new('msi',
    'DWORD MsiGetActiveDatabase(DWORD hInstall)');
# my $ret = $MsiGetActiveDatabase->Call($hInstall);
# hInstall : MSIHANDLE -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。