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

MsiSequenceW

関数
指定したシーケンステーブルのアクションを順に実行する(Unicode版)。
DLLmsi.dll文字セットUnicode (-W)呼出規約winapi対応OSwindows8.0

シグネチャ

// msi.dll  (Unicode / -W)
#include <windows.h>

DWORD MsiSequenceW(
    MSIHANDLE hInstall,
    LPCWSTR szTable,
    INT iSequenceMode
);

パラメーター

名前方向説明
hInstallMSIHANDLEinDLL カスタムアクションに渡されるインストールのハンドル、または MsiOpenPackageMsiOpenPackageExMsiOpenProduct を通じて取得したハンドルです。
szTableLPCWSTRinアクションシーケンスを含むテーブルの名前を指定します。
iSequenceModeINTinこのパラメーターは現在実装されていません。将来の使用のために予約されており、0 を指定する必要があります。

戻り値の型: DWORD

公式ドキュメント

MsiSequence 関数は、指定したテーブルに記述された別のアクションシーケンスを実行します。(Unicode)

戻り値

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

解説(Remarks)

MsiSequence 関数は、指定したテーブルをクエリし、Sequence 列の数値に従ってアクションを順序付けます。取得した各行について、指定された条件式が FALSE と評価されない限り、アクションが実行されます。

InstallFilesWriteRegistryValues アクションのように、システムを更新するアクションを含むアクションシーケンスは、 MsiSequence を呼び出して実行することはできません。この規則の例外は、 InstallInitialize アクションと InstallFinalize アクションの間で InstallExecuteSequence テーブルにスケジュールされたカスタムアクションから MsiSequence が呼び出される場合です。 AppSearchCostInitialize のように、システムを更新しないアクションは呼び出すことができます。

メモ

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

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

各言語での呼び出し定義

// msi.dll  (Unicode / -W)
#include <windows.h>

DWORD MsiSequenceW(
    MSIHANDLE hInstall,
    LPCWSTR szTable,
    INT iSequenceMode
);
[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiSequenceW(
    uint hInstall,   // MSIHANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string szTable,   // LPCWSTR
    int iSequenceMode   // INT
);
<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiSequenceW(
    hInstall As UInteger,   ' MSIHANDLE
    <MarshalAs(UnmanagedType.LPWStr)> szTable As String,   ' LPCWSTR
    iSequenceMode As Integer   ' INT
) As UInteger
End Function
' hInstall : MSIHANDLE
' szTable : LPCWSTR
' iSequenceMode : INT
Declare PtrSafe Function MsiSequenceW Lib "msi" ( _
    ByVal hInstall As Long, _
    ByVal szTable As LongPtr, _
    ByVal iSequenceMode As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MsiSequenceW = ctypes.windll.msi.MsiSequenceW
MsiSequenceW.restype = wintypes.DWORD
MsiSequenceW.argtypes = [
    wintypes.DWORD,  # hInstall : MSIHANDLE
    wintypes.LPCWSTR,  # szTable : LPCWSTR
    ctypes.c_int,  # iSequenceMode : INT
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiSequenceW = Fiddle::Function.new(
  lib['MsiSequenceW'],
  [
    -Fiddle::TYPE_INT,  # hInstall : MSIHANDLE
    Fiddle::TYPE_VOIDP,  # szTable : LPCWSTR
    Fiddle::TYPE_INT,  # iSequenceMode : INT
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "msi")]
extern "system" {
    fn MsiSequenceW(
        hInstall: u32,  // MSIHANDLE
        szTable: *const u16,  // LPCWSTR
        iSequenceMode: i32  // INT
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Unicode)]
public static extern uint MsiSequenceW(uint hInstall, [MarshalAs(UnmanagedType.LPWStr)] string szTable, int iSequenceMode);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiSequenceW' -Namespace Win32 -PassThru
# $api::MsiSequenceW(hInstall, szTable, iSequenceMode)
#uselib "msi.dll"
#func global MsiSequenceW "MsiSequenceW" wptr, wptr, wptr
; MsiSequenceW hInstall, szTable, iSequenceMode   ; 戻り値は stat
; hInstall : MSIHANDLE -> "wptr"
; szTable : LPCWSTR -> "wptr"
; iSequenceMode : INT -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "msi.dll"
#cfunc global MsiSequenceW "MsiSequenceW" int, wstr, int
; res = MsiSequenceW(hInstall, szTable, iSequenceMode)
; hInstall : MSIHANDLE -> "int"
; szTable : LPCWSTR -> "wstr"
; iSequenceMode : INT -> "int"
; DWORD MsiSequenceW(MSIHANDLE hInstall, LPCWSTR szTable, INT iSequenceMode)
#uselib "msi.dll"
#cfunc global MsiSequenceW "MsiSequenceW" int, wstr, int
; res = MsiSequenceW(hInstall, szTable, iSequenceMode)
; hInstall : MSIHANDLE -> "int"
; szTable : LPCWSTR -> "wstr"
; iSequenceMode : INT -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiSequenceW = msi.NewProc("MsiSequenceW")
)

// hInstall (MSIHANDLE), szTable (LPCWSTR), iSequenceMode (INT)
r1, _, err := procMsiSequenceW.Call(
	uintptr(hInstall),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szTable))),
	uintptr(iSequenceMode),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function MsiSequenceW(
  hInstall: DWORD;   // MSIHANDLE
  szTable: PWideChar;   // LPCWSTR
  iSequenceMode: Integer   // INT
): DWORD; stdcall;
  external 'msi.dll' name 'MsiSequenceW';
result := DllCall("msi\MsiSequenceW"
    , "UInt", hInstall   ; MSIHANDLE
    , "WStr", szTable   ; LPCWSTR
    , "Int", iSequenceMode   ; INT
    , "UInt")   ; return: DWORD
●MsiSequenceW(hInstall, szTable, iSequenceMode) = DLL("msi.dll", "dword MsiSequenceW(dword, char*, int)")
# 呼び出し: MsiSequenceW(hInstall, szTable, iSequenceMode)
# hInstall : MSIHANDLE -> "dword"
# szTable : LPCWSTR -> "char*"
# iSequenceMode : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "msi" fn MsiSequenceW(
    hInstall: u32, // MSIHANDLE
    szTable: [*c]const u16, // LPCWSTR
    iSequenceMode: i32 // INT
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc MsiSequenceW(
    hInstall: uint32,  # MSIHANDLE
    szTable: WideCString,  # LPCWSTR
    iSequenceMode: int32  # INT
): uint32 {.importc: "MsiSequenceW", stdcall, dynlib: "msi.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "msi");
extern(Windows)
uint MsiSequenceW(
    uint hInstall,   // MSIHANDLE
    const(wchar)* szTable,   // LPCWSTR
    int iSequenceMode   // INT
);
ccall((:MsiSequenceW, "msi.dll"), stdcall, UInt32,
      (UInt32, Cwstring, Int32),
      hInstall, szTable, iSequenceMode)
# hInstall : MSIHANDLE -> UInt32
# szTable : LPCWSTR -> Cwstring
# iSequenceMode : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiSequenceW(
    uint32_t hInstall,
    const uint16_t* szTable,
    int32_t iSequenceMode);
]]
local msi = ffi.load("msi")
-- msi.MsiSequenceW(hInstall, szTable, iSequenceMode)
-- hInstall : MSIHANDLE
-- szTable : LPCWSTR
-- iSequenceMode : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiSequenceW = lib.func('__stdcall', 'MsiSequenceW', 'uint32_t', ['uint32_t', 'str16', 'int32_t']);
// MsiSequenceW(hInstall, szTable, iSequenceMode)
// hInstall : MSIHANDLE -> 'uint32_t'
// szTable : LPCWSTR -> 'str16'
// iSequenceMode : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("msi.dll", {
  MsiSequenceW: { parameters: ["u32", "buffer", "i32"], result: "u32" },
});
// lib.symbols.MsiSequenceW(hInstall, szTable, iSequenceMode)
// hInstall : MSIHANDLE -> "u32"
// szTable : LPCWSTR -> "buffer"
// iSequenceMode : INT -> "i32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiSequenceW(
    uint32_t hInstall,
    const uint16_t* szTable,
    int32_t iSequenceMode);
C, "msi.dll");
// $ffi->MsiSequenceW(hInstall, szTable, iSequenceMode);
// hInstall : MSIHANDLE
// szTable : LPCWSTR
// iSequenceMode : INT
// 構造体/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, W32APIOptions.UNICODE_OPTIONS);
    int MsiSequenceW(
        int hInstall,   // MSIHANDLE
        WString szTable,   // LPCWSTR
        int iSequenceMode   // INT
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("msi")]
lib Libmsi
  fun MsiSequenceW = MsiSequenceW(
    hInstall : UInt32,   # MSIHANDLE
    szTable : UInt16*,   # LPCWSTR
    iSequenceMode : Int32   # INT
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef MsiSequenceWNative = Uint32 Function(Uint32, Pointer<Utf16>, Int32);
typedef MsiSequenceWDart = int Function(int, Pointer<Utf16>, int);
final MsiSequenceW = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiSequenceWNative, MsiSequenceWDart>('MsiSequenceW');
// hInstall : MSIHANDLE -> Uint32
// szTable : LPCWSTR -> Pointer<Utf16>
// iSequenceMode : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiSequenceW(
  hInstall: DWORD;   // MSIHANDLE
  szTable: PWideChar;   // LPCWSTR
  iSequenceMode: Integer   // INT
): DWORD; stdcall;
  external 'msi.dll' name 'MsiSequenceW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

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

(cffi:defcfun ("MsiSequenceW" msi-sequence-w :convention :stdcall) :uint32
  (h-install :uint32)   ; MSIHANDLE
  (sz-table (:string :encoding :utf-16le))   ; LPCWSTR
  (i-sequence-mode :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiSequenceW = Win32::API::More->new('msi',
    'DWORD MsiSequenceW(DWORD hInstall, LPCWSTR szTable, int iSequenceMode)');
# my $ret = $MsiSequenceW->Call($hInstall, $szTable, $iSequenceMode);
# hInstall : MSIHANDLE -> DWORD
# szTable : LPCWSTR -> LPCWSTR
# iSequenceMode : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い