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

MsiEnableUIPreview

関数
データベースのダイアログをプレビューするUIを有効化する。
DLLmsi.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD MsiEnableUIPreview(
    MSIHANDLE hDatabase,
    MSIHANDLE* phPreview
);

パラメーター

名前方向説明
hDatabaseMSIHANDLEinデータベースへのハンドル。
phPreviewMSIHANDLE*inoutユーザーインターフェイスのプレビュー機能用に返されるハンドルへのポインター。

戻り値の型: DWORD

公式ドキュメント

MsiEnableUIPreview 関数は、ユーザーインターフェイスのプレビューモードを有効にし、ユーザーインターフェイスのダイアログボックスの作成を支援します。この関数は、MsiCloseHandle を使用して閉じる必要があるハンドルを返します。

戻り値

この関数は UINT を返します。

解説(Remarks)

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>

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

MsiEnableUIPreview = ctypes.windll.msi.MsiEnableUIPreview
MsiEnableUIPreview.restype = wintypes.DWORD
MsiEnableUIPreview.argtypes = [
    wintypes.DWORD,  # hDatabase : MSIHANDLE
    ctypes.c_void_p,  # phPreview : MSIHANDLE* in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiEnableUIPreview = msi.NewProc("MsiEnableUIPreview")
)

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

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

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

foreign import stdcall safe "MsiEnableUIPreview"
  c_MsiEnableUIPreview :: Word32 -> Ptr Word32 -> IO Word32
-- hDatabase : MSIHANDLE -> Word32
-- phPreview : MSIHANDLE* in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msienableuipreview =
  foreign "MsiEnableUIPreview"
    (uint32_t @-> (ptr uint32_t) @-> returning uint32_t)
(* hDatabase : MSIHANDLE -> uint32_t *)
(* phPreview : MSIHANDLE* in/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 ("MsiEnableUIPreview" msi-enable-uipreview :convention :stdcall) :uint32
  (h-database :uint32)   ; MSIHANDLE
  (ph-preview :pointer))   ; MSIHANDLE* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiEnableUIPreview = Win32::API::More->new('msi',
    'DWORD MsiEnableUIPreview(DWORD hDatabase, LPVOID phPreview)');
# my $ret = $MsiEnableUIPreview->Call($hDatabase, $phPreview);
# hDatabase : MSIHANDLE -> DWORD
# phPreview : MSIHANDLE* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。