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

MsiGetMode

関数
インストールセッションが指定した実行モードかどうかを判定する。
DLLmsi.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

BOOL MsiGetMode(
    MSIHANDLE hInstall,
    MSIRUNMODE eRunMode
);

パラメーター

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

実行モードを指定します。このパラメーターには次のいずれかの値を指定する必要があります。

意味
MSIRUNMODE_ADMIN
管理モードでインストール中、または製品をインストール中です。
MSIRUNMODE_ADVERTISE
アドバタイズをインストール中、または製品をインストールもしくは更新中です。
MSIRUNMODE_MAINTENANCE
既存のインストールが変更されているか、新規インストールがあります。
MSIRUNMODE_ROLLBACKENABLED
ロールバックが有効です。
MSIRUNMODE_LOGENABLED
ログファイルがアクティブです。インストールセッションの開始前に有効化されていました。
MSIRUNMODE_OPERATIONS
実行操作が判定フェーズにあります。
MSIRUNMODE_REBOOTATEND
インストールが正常に完了した後に再起動が必要です(設定可能)。
MSIRUNMODE_REBOOTNOW
インストールを続行するために再起動が必要です(設定可能)。
MSIRUNMODE_CABINET
キャビネットおよび Media テーブル のファイルをインストール中です。
MSIRUNMODE_SOURCESHORTNAMES
ソースの LongFileNames が PID_MSISOURCE 概要プロパティによって抑制されています。
MSIRUNMODE_TARGETSHORTNAMES
ターゲットの LongFileNames が SHORTFILENAMES プロパティによって抑制されています。
MSIRUNMODE_RESERVED11
将来の使用のために予約されています。
MSIRUNMODE_WINDOWS9X
オペレーティングシステムが 9x 系のバージョンです。
MSIRUNMODE_ZAWENABLED
オペレーティングシステムがオンデマンドインストールをサポートしています。
MSIRUNMODE_RESERVED14
将来の使用のために予約されています。
MSIRUNMODE_RESERVED15
将来の使用のために予約されています。
MSIRUNMODE_SCHEDULED
インストールスクリプトの実行から呼び出されたカスタムアクションです。
MSIRUNMODE_ROLLBACK
ロールバック実行スクリプトから呼び出されたカスタムアクションです。
MSIRUNMODE_COMMIT
コミット実行スクリプトから呼び出されたカスタムアクションです。

戻り値の型: BOOL

公式ドキュメント

MsiGetMode 関数は、インストーラーが現在、表に示された指定のモードで動作しているかどうかを判定するために使用します。

戻り値

TRUE は、関数に渡された特定のプロパティが現在設定されていることを示します。

FALSE は、関数に渡された特定のプロパティが現在設定されていないことを示します。

解説(Remarks)

遅延カスタムアクションから MsiGetMode を呼び出す場合、iRunMode のすべての実行モード値が利用できるわけではないことに注意してください。詳細については、 遅延実行カスタムアクションのコンテキスト情報の取得を参照してください。

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

各言語での呼び出し定義

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

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

MsiGetMode = ctypes.windll.msi.MsiGetMode
MsiGetMode.restype = wintypes.BOOL
MsiGetMode.argtypes = [
    wintypes.DWORD,  # hInstall : MSIHANDLE
    ctypes.c_int,  # eRunMode : MSIRUNMODE
]
require 'fiddle'
require 'fiddle/import'

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

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiGetMode = msi.NewProc("MsiGetMode")
)

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

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

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

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

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

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

関連項目

使用する型