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

MsiConfigureProductW

関数
製品のインストール状態を構成変更する(Unicode版)。
DLLmsi.dll文字セットUnicode (-W)呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD MsiConfigureProductW(
    LPCWSTR szProduct,
    INSTALLLEVEL iInstallLevel,
    INSTALLSTATE eInstallState
);

パラメーター

名前方向説明
szProductLPCWSTRin構成する製品の製品コードを指定します。
iInstallLevelINSTALLLEVELin

製品を既定の状態にインストールする際に、製品をどの程度までインストールするかを指定します。eInstallState パラメーターに INSTALLSTATE_DEFAULT 以外の値が設定されている場合、iInstallLevel パラメーターは無視され、すべての機能がインストールされます。

このパラメーターには、次のいずれかの値を指定できます。

意味
INSTALLLEVEL_DEFAULT
オーサリングされた既定の機能がインストールされます。
INSTALLLEVEL_MINIMUM
必須の機能のみがインストールされます。INSTALLLEVEL_MINIMUM から INSTALLLEVEL_MAXIMUM の間の値を指定して、利用可能な機能の一部をインストールすることができます。
INSTALLLEVEL_MAXIMUM
すべての機能がインストールされます。INSTALLLEVEL_MINIMUM から INSTALLLEVEL_MAXIMUM の間の値を指定して、利用可能な機能の一部をインストールすることができます。
eInstallStateINSTALLSTATEin

製品のインストール状態を指定します。このパラメーターには、次のいずれかの値を指定できます。

意味
INSTALLSTATE_LOCAL
製品は、すべての機能をローカルにインストールした状態でインストールされます。
INSTALLSTATE_ABSENT
製品はアンインストールされます。
INSTALLSTATE_SOURCE
製品は、すべての機能をソースから実行するようにインストールした状態でインストールされます。
INSTALLSTATE_DEFAULT
製品は、Feature Table で指定された既定の状態で、すべての機能をインストールした状態でインストールされます。
INSTALLSTATE_ADVERTISED
製品は広告 (advertise) されます。

戻り値の型: DWORD

公式ドキュメント

MsiConfigureProduct 関数は、製品をインストールまたはアンインストールします。(Unicode)

戻り値

意味
ERROR_INVALID_PARAMETER
無効なパラメーターが関数に渡されました。
ERROR_SUCCESS
関数が成功しました。
アクションに関連するエラー
詳細については、 Error Codes を参照してください。
Initialization Error
初期化に関連するエラーです。

解説(Remarks)

MsiConfigureProduct 関数は、現在の設定を使用してユーザーインターフェイス (UI) を表示します。ユーザーインターフェイスの設定は、 MsiSetInternalUIMsiSetExternalUI、または MsiSetExternalUIRecord を使用して変更できます。

eInstallState パラメーターに INSTALLSTATE_DEFAULT 以外の値が設定されている場合、iInstallLevel パラメーターは無視され、製品のすべての機能がインストールされます。eInstallState パラメーターが INSTALLSTATE_DEFAULT に設定されていない場合に個々の機能のインストールを制御するには、 MsiConfigureFeature を使用してください。

メモ

msi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして MsiConfigureProduct を定義します。エンコーディング中立のエイリアスを、エンコーディング中立でないコードと混在して使用すると、不一致が生じ、コンパイルエラーや実行時エラーの原因となる場合があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 MsiConfigureProductW(
    LPCWSTR szProduct,
    INSTALLLEVEL iInstallLevel,
    INSTALLSTATE eInstallState
);
[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiConfigureProductW(
    [MarshalAs(UnmanagedType.LPWStr)] string szProduct,   // LPCWSTR
    int iInstallLevel,   // INSTALLLEVEL
    int eInstallState   // INSTALLSTATE
);
<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiConfigureProductW(
    <MarshalAs(UnmanagedType.LPWStr)> szProduct As String,   ' LPCWSTR
    iInstallLevel As Integer,   ' INSTALLLEVEL
    eInstallState As Integer   ' INSTALLSTATE
) As UInteger
End Function
' szProduct : LPCWSTR
' iInstallLevel : INSTALLLEVEL
' eInstallState : INSTALLSTATE
Declare PtrSafe Function MsiConfigureProductW Lib "msi" ( _
    ByVal szProduct As LongPtr, _
    ByVal iInstallLevel As Long, _
    ByVal eInstallState 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

MsiConfigureProductW = ctypes.windll.msi.MsiConfigureProductW
MsiConfigureProductW.restype = wintypes.DWORD
MsiConfigureProductW.argtypes = [
    wintypes.LPCWSTR,  # szProduct : LPCWSTR
    ctypes.c_int,  # iInstallLevel : INSTALLLEVEL
    ctypes.c_int,  # eInstallState : INSTALLSTATE
]
require 'fiddle'
require 'fiddle/import'

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

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiConfigureProductW = msi.NewProc("MsiConfigureProductW")
)

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

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

typedef MsiConfigureProductWNative = Uint32 Function(Pointer<Utf16>, Int32, Int32);
typedef MsiConfigureProductWDart = int Function(Pointer<Utf16>, int, int);
final MsiConfigureProductW = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiConfigureProductWNative, MsiConfigureProductWDart>('MsiConfigureProductW');
// szProduct : LPCWSTR -> Pointer<Utf16>
// iInstallLevel : INSTALLLEVEL -> Int32
// eInstallState : INSTALLSTATE -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiConfigureProductW(
  szProduct: PWideChar;   // LPCWSTR
  iInstallLevel: Integer;   // INSTALLLEVEL
  eInstallState: Integer   // INSTALLSTATE
): DWORD; stdcall;
  external 'msi.dll' name 'MsiConfigureProductW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiConfigureProductW"
  c_MsiConfigureProductW :: CWString -> Int32 -> Int32 -> IO Word32
-- szProduct : LPCWSTR -> CWString
-- iInstallLevel : INSTALLLEVEL -> Int32
-- eInstallState : INSTALLSTATE -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msiconfigureproductw =
  foreign "MsiConfigureProductW"
    ((ptr uint16_t) @-> int32_t @-> int32_t @-> returning uint32_t)
(* szProduct : LPCWSTR -> (ptr uint16_t) *)
(* iInstallLevel : INSTALLLEVEL -> int32_t *)
(* eInstallState : INSTALLSTATE -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)

(cffi:defcfun ("MsiConfigureProductW" msi-configure-product-w :convention :stdcall) :uint32
  (sz-product (:string :encoding :utf-16le))   ; LPCWSTR
  (i-install-level :int32)   ; INSTALLLEVEL
  (e-install-state :int32))   ; INSTALLSTATE
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiConfigureProductW = Win32::API::More->new('msi',
    'DWORD MsiConfigureProductW(LPCWSTR szProduct, int iInstallLevel, int eInstallState)');
# my $ret = $MsiConfigureProductW->Call($szProduct, $iInstallLevel, $eInstallState);
# szProduct : LPCWSTR -> LPCWSTR
# iInstallLevel : INSTALLLEVEL -> int
# eInstallState : INSTALLSTATE -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API
使用する型