ホーム › System.ApplicationInstallationAndServicing › MsiInstallProductW
MsiInstallProductW
関数MSIパッケージから製品をインストールする(Unicode版)。
シグネチャ
// msi.dll (Unicode / -W)
#include <windows.h>
DWORD MsiInstallProductW(
LPCWSTR szPackagePath,
LPCWSTR szCommandLine // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 |
|---|---|---|---|
| szPackagePath | LPCWSTR | in | Windows Installer パッケージの場所へのパスを指定する、null 終端文字列です。この文字列値には、URL(例: http://packageLocation/package/package.msi)、ネットワークパス(例: \packageLocation\package.msi)、ファイルパス(例: file://packageLocation/package.msi)、またはローカルパス(例: D:\packageLocation\package.msi)を指定できます。 |
| szCommandLine | LPCWSTR | inoptional | コマンドライン プロパティ設定を指定する、null 終端文字列です。これは Property=Setting Property=Setting の形式のリストである必要があります。詳細については、 About Properties を参照してください。 管理インストールを実行するには、szCommandLine に ACTION=ADMIN を含めます。詳細については、 ACTION プロパティを参照してください。 |
戻り値の型: DWORD
公式ドキュメント
製品をインストールまたはアンインストールします。(MsiInstallProductW)
戻り値
| 値 | 意味 |
|---|---|
| 関数が正常に完了しました。 | |
|
詳細については、 Error Codes を参照してください。 |
| 初期化に関連するエラーが発生しました。 |
詳細については、 Displayed Error Messages を参照してください。
解説(Remarks)
MsiInstallProduct 関数は、現在の設定とログモードでユーザーインターフェイスを表示します。
- ユーザーインターフェイスの設定は、 MsiSetInternalUI、 MsiSetExternalUI、または MsiSetExternalUIRecord 関数を使用して変更できます。
- ログモードは、 MsiEnableLog 関数を使用して設定できます。
- szCommandLine に REMOVE=ALL を設定することで、製品を完全に削除できます。
メモ
msi.h ヘッダーは MsiInstallProduct を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング非依存のエイリアスを、エンコーディング非依存でないコードと混在させて使用すると、不一致が生じてコンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// msi.dll (Unicode / -W)
#include <windows.h>
DWORD MsiInstallProductW(
LPCWSTR szPackagePath,
LPCWSTR szCommandLine // optional
);[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiInstallProductW(
[MarshalAs(UnmanagedType.LPWStr)] string szPackagePath, // LPCWSTR
[MarshalAs(UnmanagedType.LPWStr)] string szCommandLine // LPCWSTR optional
);<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiInstallProductW(
<MarshalAs(UnmanagedType.LPWStr)> szPackagePath As String, ' LPCWSTR
<MarshalAs(UnmanagedType.LPWStr)> szCommandLine As String ' LPCWSTR optional
) As UInteger
End Function' szPackagePath : LPCWSTR
' szCommandLine : LPCWSTR optional
Declare PtrSafe Function MsiInstallProductW Lib "msi" ( _
ByVal szPackagePath As LongPtr, _
ByVal szCommandLine As LongPtr) 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
MsiInstallProductW = ctypes.windll.msi.MsiInstallProductW
MsiInstallProductW.restype = wintypes.DWORD
MsiInstallProductW.argtypes = [
wintypes.LPCWSTR, # szPackagePath : LPCWSTR
wintypes.LPCWSTR, # szCommandLine : LPCWSTR optional
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('msi.dll')
MsiInstallProductW = Fiddle::Function.new(
lib['MsiInstallProductW'],
[
Fiddle::TYPE_VOIDP, # szPackagePath : LPCWSTR
Fiddle::TYPE_VOIDP, # szCommandLine : LPCWSTR optional
],
-Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"#[link(name = "msi")]
extern "system" {
fn MsiInstallProductW(
szPackagePath: *const u16, // LPCWSTR
szCommandLine: *const u16 // LPCWSTR optional
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Unicode)]
public static extern uint MsiInstallProductW([MarshalAs(UnmanagedType.LPWStr)] string szPackagePath, [MarshalAs(UnmanagedType.LPWStr)] string szCommandLine);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiInstallProductW' -Namespace Win32 -PassThru
# $api::MsiInstallProductW(szPackagePath, szCommandLine)#uselib "msi.dll"
#func global MsiInstallProductW "MsiInstallProductW" wptr, wptr
; MsiInstallProductW szPackagePath, szCommandLine ; 戻り値は stat
; szPackagePath : LPCWSTR -> "wptr"
; szCommandLine : LPCWSTR optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "msi.dll"
#cfunc global MsiInstallProductW "MsiInstallProductW" wstr, wstr
; res = MsiInstallProductW(szPackagePath, szCommandLine)
; szPackagePath : LPCWSTR -> "wstr"
; szCommandLine : LPCWSTR optional -> "wstr"; DWORD MsiInstallProductW(LPCWSTR szPackagePath, LPCWSTR szCommandLine)
#uselib "msi.dll"
#cfunc global MsiInstallProductW "MsiInstallProductW" wstr, wstr
; res = MsiInstallProductW(szPackagePath, szCommandLine)
; szPackagePath : LPCWSTR -> "wstr"
; szCommandLine : LPCWSTR optional -> "wstr"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
msi = windows.NewLazySystemDLL("msi.dll")
procMsiInstallProductW = msi.NewProc("MsiInstallProductW")
)
// szPackagePath (LPCWSTR), szCommandLine (LPCWSTR optional)
r1, _, err := procMsiInstallProductW.Call(
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szPackagePath))),
uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szCommandLine))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction MsiInstallProductW(
szPackagePath: PWideChar; // LPCWSTR
szCommandLine: PWideChar // LPCWSTR optional
): DWORD; stdcall;
external 'msi.dll' name 'MsiInstallProductW';result := DllCall("msi\MsiInstallProductW"
, "WStr", szPackagePath ; LPCWSTR
, "WStr", szCommandLine ; LPCWSTR optional
, "UInt") ; return: DWORD●MsiInstallProductW(szPackagePath, szCommandLine) = DLL("msi.dll", "dword MsiInstallProductW(char*, char*)")
# 呼び出し: MsiInstallProductW(szPackagePath, szCommandLine)
# szPackagePath : LPCWSTR -> "char*"
# szCommandLine : LPCWSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。const std = @import("std");
extern "msi" fn MsiInstallProductW(
szPackagePath: [*c]const u16, // LPCWSTR
szCommandLine: [*c]const u16 // LPCWSTR optional
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。proc MsiInstallProductW(
szPackagePath: WideCString, # LPCWSTR
szCommandLine: WideCString # LPCWSTR optional
): uint32 {.importc: "MsiInstallProductW", stdcall, dynlib: "msi.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。pragma(lib, "msi");
extern(Windows)
uint MsiInstallProductW(
const(wchar)* szPackagePath, // LPCWSTR
const(wchar)* szCommandLine // LPCWSTR optional
);ccall((:MsiInstallProductW, "msi.dll"), stdcall, UInt32,
(Cwstring, Cwstring),
szPackagePath, szCommandLine)
# szPackagePath : LPCWSTR -> Cwstring
# szCommandLine : LPCWSTR optional -> Cwstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiInstallProductW(
const uint16_t* szPackagePath,
const uint16_t* szCommandLine);
]]
local msi = ffi.load("msi")
-- msi.MsiInstallProductW(szPackagePath, szCommandLine)
-- szPackagePath : LPCWSTR
-- szCommandLine : LPCWSTR optional
-- 構造体/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 MsiInstallProductW = lib.func('__stdcall', 'MsiInstallProductW', 'uint32_t', ['str16', 'str16']);
// MsiInstallProductW(szPackagePath, szCommandLine)
// szPackagePath : LPCWSTR -> 'str16'
// szCommandLine : LPCWSTR optional -> 'str16'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("msi.dll", {
MsiInstallProductW: { parameters: ["buffer", "buffer"], result: "u32" },
});
// lib.symbols.MsiInstallProductW(szPackagePath, szCommandLine)
// szPackagePath : LPCWSTR -> "buffer"
// szCommandLine : LPCWSTR optional -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiInstallProductW(
const uint16_t* szPackagePath,
const uint16_t* szCommandLine);
C, "msi.dll");
// $ffi->MsiInstallProductW(szPackagePath, szCommandLine);
// szPackagePath : LPCWSTR
// szCommandLine : LPCWSTR optional
// 構造体/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 MsiInstallProductW(
WString szPackagePath, // LPCWSTR
WString szCommandLine // LPCWSTR optional
);
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。@[Link("msi")]
lib Libmsi
fun MsiInstallProductW = MsiInstallProductW(
szPackagePath : UInt16*, # LPCWSTR
szCommandLine : UInt16* # LPCWSTR optional
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef MsiInstallProductWNative = Uint32 Function(Pointer<Utf16>, Pointer<Utf16>);
typedef MsiInstallProductWDart = int Function(Pointer<Utf16>, Pointer<Utf16>);
final MsiInstallProductW = DynamicLibrary.open('msi.dll')
.lookupFunction<MsiInstallProductWNative, MsiInstallProductWDart>('MsiInstallProductW');
// szPackagePath : LPCWSTR -> Pointer<Utf16>
// szCommandLine : LPCWSTR optional -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function MsiInstallProductW(
szPackagePath: PWideChar; // LPCWSTR
szCommandLine: PWideChar // LPCWSTR optional
): DWORD; stdcall;
external 'msi.dll' name 'MsiInstallProductW';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "MsiInstallProductW"
c_MsiInstallProductW :: CWString -> CWString -> IO Word32
-- szPackagePath : LPCWSTR -> CWString
-- szCommandLine : LPCWSTR optional -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let msiinstallproductw =
foreign "MsiInstallProductW"
((ptr uint16_t) @-> (ptr uint16_t) @-> returning uint32_t)
(* szPackagePath : LPCWSTR -> (ptr uint16_t) *)
(* szCommandLine : LPCWSTR optional -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)
(cffi:defcfun ("MsiInstallProductW" msi-install-product-w :convention :stdcall) :uint32
(sz-package-path (:string :encoding :utf-16le)) ; LPCWSTR
(sz-command-line (:string :encoding :utf-16le))) ; LPCWSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $MsiInstallProductW = Win32::API::More->new('msi',
'DWORD MsiInstallProductW(LPCWSTR szPackagePath, LPCWSTR szCommandLine)');
# my $ret = $MsiInstallProductW->Call($szPackagePath, $szCommandLine);
# szPackagePath : LPCWSTR -> LPCWSTR
# szCommandLine : LPCWSTR optional -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。関連項目
文字セット違い
- f MsiInstallProductA (ANSI版) — MSIパッケージから製品をインストールする(ANSI版)。