MsiApplyPatchA
関数シグネチャ
// msi.dll (ANSI / -A)
#include <windows.h>
DWORD MsiApplyPatchA(
LPCSTR szPatchPackage,
LPCSTR szInstallPackage, // optional
INSTALLTYPE eInstallType,
LPCSTR szCommandLine // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| szPatchPackage | LPCSTR | in | パッチパッケージへのフルパスを指定する、null 終端文字列です。 | ||||||||
| szInstallPackage | LPCSTR | inoptional | eInstallType に INSTALLTYPE_NETWORK_IMAGE が設定されている場合、このパラメーターはパッチを適用する製品へのパスを指定する null 終端文字列です。szInstallPackage が null に設定され、かつ eInstallType が INSTALLTYPE_DEFAULT に設定されている場合、インストーラーはパッチパッケージに列挙された対象となるすべての製品にパッチを適用します。 eInstallType が INSTALLTYPE_SINGLE_INSTANCE の場合、インストーラーは szInstallPackage で指定された製品にパッチを適用します。この場合、パッチパッケージに列挙された他の対象製品は無視され、szInstallPackage パラメーターにはパッチを適用するインスタンスの製品コードを表す null 終端文字列が格納されます。この種類のインストールには、Windows Server 2003 または Windows XP 上で動作するインストーラーが必要です。 | ||||||||
| eInstallType | INSTALLTYPE | in | このパラメーターはパッチを適用するインストールの種類を指定します。
| ||||||||
| szCommandLine | LPCSTR | inoptional | コマンドラインのプロパティ設定を指定する null 終端文字列です。 Properties および Setting Public Property Values on the Command Line を参照してください。「解説」セクションも参照してください。 |
戻り値の型: DWORD
公式ドキュメント
パッチパッケージがパッチ適用対象として列挙している各製品に対して、MsiApplyPatch 関数はインストールを起動し、PATCH プロパティをパッチパッケージのパスに設定します。(ANSI)
戻り値
| 値 | 意味 |
|---|---|
| 関数は正常に完了しました。 | |
| パッチパッケージを開くことができませんでした。 | |
| パッチパッケージが無効です。 | |
| パッチパッケージはサポートされていません。 | |
|
Error Codes を参照してください。 |
| 初期化エラーが発生しました。 |
解説(Remarks)
トランスフォーム、ソース、パッチのリスト区切り文字はセミコロンであるため、この文字をファイル名やパスに使用しないでください。
小規模更新またはマイナーアップグレードのパッチを適用する際は、コマンドラインで REINSTALL プロパティを設定する必要があります。このプロパティを設定しない場合、パッチはシステムに登録されますが、ファイルを更新できません。Custom Action Type 51 を使用して REINSTALL および REINSTALLMODE プロパティを自動的に設定しないパッチでは、szCommandLine パラメーターで REINSTALL プロパティを明示的に設定する必要があります。パッチの影響を受ける機能を列挙するように REINSTALL プロパティを設定するか、実用的な既定値として "REINSTALL=ALL" を使用してください。REINSTALLMODE プロパティの既定値は "omus" です。Windows Installer バージョン 3.0 以降では、REINSTALL プロパティはインストーラーによって構成されるため、コマンドラインで設定する必要はありません。
msi.h ヘッダーは MsiApplyPatch を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存ではないコードと混在させて使用すると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// msi.dll (ANSI / -A)
#include <windows.h>
DWORD MsiApplyPatchA(
LPCSTR szPatchPackage,
LPCSTR szInstallPackage, // optional
INSTALLTYPE eInstallType,
LPCSTR szCommandLine // optional
);[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiApplyPatchA(
[MarshalAs(UnmanagedType.LPStr)] string szPatchPackage, // LPCSTR
[MarshalAs(UnmanagedType.LPStr)] string szInstallPackage, // LPCSTR optional
int eInstallType, // INSTALLTYPE
[MarshalAs(UnmanagedType.LPStr)] string szCommandLine // LPCSTR optional
);<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiApplyPatchA(
<MarshalAs(UnmanagedType.LPStr)> szPatchPackage As String, ' LPCSTR
<MarshalAs(UnmanagedType.LPStr)> szInstallPackage As String, ' LPCSTR optional
eInstallType As Integer, ' INSTALLTYPE
<MarshalAs(UnmanagedType.LPStr)> szCommandLine As String ' LPCSTR optional
) As UInteger
End Function' szPatchPackage : LPCSTR
' szInstallPackage : LPCSTR optional
' eInstallType : INSTALLTYPE
' szCommandLine : LPCSTR optional
Declare PtrSafe Function MsiApplyPatchA Lib "msi" ( _
ByVal szPatchPackage As String, _
ByVal szInstallPackage As String, _
ByVal eInstallType As Long, _
ByVal szCommandLine As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
MsiApplyPatchA = ctypes.windll.msi.MsiApplyPatchA
MsiApplyPatchA.restype = wintypes.DWORD
MsiApplyPatchA.argtypes = [
wintypes.LPCSTR, # szPatchPackage : LPCSTR
wintypes.LPCSTR, # szInstallPackage : LPCSTR optional
ctypes.c_int, # eInstallType : INSTALLTYPE
wintypes.LPCSTR, # szCommandLine : LPCSTR optional
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('msi.dll')
MsiApplyPatchA = Fiddle::Function.new(
lib['MsiApplyPatchA'],
[
Fiddle::TYPE_VOIDP, # szPatchPackage : LPCSTR
Fiddle::TYPE_VOIDP, # szInstallPackage : LPCSTR optional
Fiddle::TYPE_INT, # eInstallType : INSTALLTYPE
Fiddle::TYPE_VOIDP, # szCommandLine : LPCSTR optional
],
-Fiddle::TYPE_INT)#[link(name = "msi")]
extern "system" {
fn MsiApplyPatchA(
szPatchPackage: *const u8, // LPCSTR
szInstallPackage: *const u8, // LPCSTR optional
eInstallType: i32, // INSTALLTYPE
szCommandLine: *const u8 // LPCSTR optional
) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Ansi)]
public static extern uint MsiApplyPatchA([MarshalAs(UnmanagedType.LPStr)] string szPatchPackage, [MarshalAs(UnmanagedType.LPStr)] string szInstallPackage, int eInstallType, [MarshalAs(UnmanagedType.LPStr)] string szCommandLine);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiApplyPatchA' -Namespace Win32 -PassThru
# $api::MsiApplyPatchA(szPatchPackage, szInstallPackage, eInstallType, szCommandLine)#uselib "msi.dll"
#func global MsiApplyPatchA "MsiApplyPatchA" sptr, sptr, sptr, sptr
; MsiApplyPatchA szPatchPackage, szInstallPackage, eInstallType, szCommandLine ; 戻り値は stat
; szPatchPackage : LPCSTR -> "sptr"
; szInstallPackage : LPCSTR optional -> "sptr"
; eInstallType : INSTALLTYPE -> "sptr"
; szCommandLine : LPCSTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "msi.dll"
#cfunc global MsiApplyPatchA "MsiApplyPatchA" str, str, int, str
; res = MsiApplyPatchA(szPatchPackage, szInstallPackage, eInstallType, szCommandLine)
; szPatchPackage : LPCSTR -> "str"
; szInstallPackage : LPCSTR optional -> "str"
; eInstallType : INSTALLTYPE -> "int"
; szCommandLine : LPCSTR optional -> "str"; DWORD MsiApplyPatchA(LPCSTR szPatchPackage, LPCSTR szInstallPackage, INSTALLTYPE eInstallType, LPCSTR szCommandLine)
#uselib "msi.dll"
#cfunc global MsiApplyPatchA "MsiApplyPatchA" str, str, int, str
; res = MsiApplyPatchA(szPatchPackage, szInstallPackage, eInstallType, szCommandLine)
; szPatchPackage : LPCSTR -> "str"
; szInstallPackage : LPCSTR optional -> "str"
; eInstallType : INSTALLTYPE -> "int"
; szCommandLine : LPCSTR optional -> "str"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
msi = windows.NewLazySystemDLL("msi.dll")
procMsiApplyPatchA = msi.NewProc("MsiApplyPatchA")
)
// szPatchPackage (LPCSTR), szInstallPackage (LPCSTR optional), eInstallType (INSTALLTYPE), szCommandLine (LPCSTR optional)
r1, _, err := procMsiApplyPatchA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(szPatchPackage))),
uintptr(unsafe.Pointer(windows.BytePtrFromString(szInstallPackage))),
uintptr(eInstallType),
uintptr(unsafe.Pointer(windows.BytePtrFromString(szCommandLine))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction MsiApplyPatchA(
szPatchPackage: PAnsiChar; // LPCSTR
szInstallPackage: PAnsiChar; // LPCSTR optional
eInstallType: Integer; // INSTALLTYPE
szCommandLine: PAnsiChar // LPCSTR optional
): DWORD; stdcall;
external 'msi.dll' name 'MsiApplyPatchA';result := DllCall("msi\MsiApplyPatchA"
, "AStr", szPatchPackage ; LPCSTR
, "AStr", szInstallPackage ; LPCSTR optional
, "Int", eInstallType ; INSTALLTYPE
, "AStr", szCommandLine ; LPCSTR optional
, "UInt") ; return: DWORD●MsiApplyPatchA(szPatchPackage, szInstallPackage, eInstallType, szCommandLine) = DLL("msi.dll", "dword MsiApplyPatchA(char*, char*, int, char*)")
# 呼び出し: MsiApplyPatchA(szPatchPackage, szInstallPackage, eInstallType, szCommandLine)
# szPatchPackage : LPCSTR -> "char*"
# szInstallPackage : LPCSTR optional -> "char*"
# eInstallType : INSTALLTYPE -> "int"
# szCommandLine : LPCSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "msi" fn MsiApplyPatchA(
szPatchPackage: [*c]const u8, // LPCSTR
szInstallPackage: [*c]const u8, // LPCSTR optional
eInstallType: i32, // INSTALLTYPE
szCommandLine: [*c]const u8 // LPCSTR optional
) callconv(std.os.windows.WINAPI) u32;proc MsiApplyPatchA(
szPatchPackage: cstring, # LPCSTR
szInstallPackage: cstring, # LPCSTR optional
eInstallType: int32, # INSTALLTYPE
szCommandLine: cstring # LPCSTR optional
): uint32 {.importc: "MsiApplyPatchA", stdcall, dynlib: "msi.dll".}pragma(lib, "msi");
extern(Windows)
uint MsiApplyPatchA(
const(char)* szPatchPackage, // LPCSTR
const(char)* szInstallPackage, // LPCSTR optional
int eInstallType, // INSTALLTYPE
const(char)* szCommandLine // LPCSTR optional
);ccall((:MsiApplyPatchA, "msi.dll"), stdcall, UInt32,
(Cstring, Cstring, Int32, Cstring),
szPatchPackage, szInstallPackage, eInstallType, szCommandLine)
# szPatchPackage : LPCSTR -> Cstring
# szInstallPackage : LPCSTR optional -> Cstring
# eInstallType : INSTALLTYPE -> Int32
# szCommandLine : LPCSTR optional -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiApplyPatchA(
const char* szPatchPackage,
const char* szInstallPackage,
int32_t eInstallType,
const char* szCommandLine);
]]
local msi = ffi.load("msi")
-- msi.MsiApplyPatchA(szPatchPackage, szInstallPackage, eInstallType, szCommandLine)
-- szPatchPackage : LPCSTR
-- szInstallPackage : LPCSTR optional
-- eInstallType : INSTALLTYPE
-- szCommandLine : LPCSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiApplyPatchA = lib.func('__stdcall', 'MsiApplyPatchA', 'uint32_t', ['str', 'str', 'int32_t', 'str']);
// MsiApplyPatchA(szPatchPackage, szInstallPackage, eInstallType, szCommandLine)
// szPatchPackage : LPCSTR -> 'str'
// szInstallPackage : LPCSTR optional -> 'str'
// eInstallType : INSTALLTYPE -> 'int32_t'
// szCommandLine : LPCSTR optional -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("msi.dll", {
MsiApplyPatchA: { parameters: ["buffer", "buffer", "i32", "buffer"], result: "u32" },
});
// lib.symbols.MsiApplyPatchA(szPatchPackage, szInstallPackage, eInstallType, szCommandLine)
// szPatchPackage : LPCSTR -> "buffer"
// szInstallPackage : LPCSTR optional -> "buffer"
// eInstallType : INSTALLTYPE -> "i32"
// szCommandLine : LPCSTR optional -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiApplyPatchA(
const char* szPatchPackage,
const char* szInstallPackage,
int32_t eInstallType,
const char* szCommandLine);
C, "msi.dll");
// $ffi->MsiApplyPatchA(szPatchPackage, szInstallPackage, eInstallType, szCommandLine);
// szPatchPackage : LPCSTR
// szInstallPackage : LPCSTR optional
// eInstallType : INSTALLTYPE
// szCommandLine : LPCSTR 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.ASCII_OPTIONS);
int MsiApplyPatchA(
String szPatchPackage, // LPCSTR
String szInstallPackage, // LPCSTR optional
int eInstallType, // INSTALLTYPE
String szCommandLine // LPCSTR optional
);
}@[Link("msi")]
lib Libmsi
fun MsiApplyPatchA = MsiApplyPatchA(
szPatchPackage : UInt8*, # LPCSTR
szInstallPackage : UInt8*, # LPCSTR optional
eInstallType : Int32, # INSTALLTYPE
szCommandLine : UInt8* # LPCSTR optional
) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。import 'dart:ffi';
import 'package:ffi/ffi.dart';
typedef MsiApplyPatchANative = Uint32 Function(Pointer<Utf8>, Pointer<Utf8>, Int32, Pointer<Utf8>);
typedef MsiApplyPatchADart = int Function(Pointer<Utf8>, Pointer<Utf8>, int, Pointer<Utf8>);
final MsiApplyPatchA = DynamicLibrary.open('msi.dll')
.lookupFunction<MsiApplyPatchANative, MsiApplyPatchADart>('MsiApplyPatchA');
// szPatchPackage : LPCSTR -> Pointer<Utf8>
// szInstallPackage : LPCSTR optional -> Pointer<Utf8>
// eInstallType : INSTALLTYPE -> Int32
// szCommandLine : LPCSTR optional -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function MsiApplyPatchA(
szPatchPackage: PAnsiChar; // LPCSTR
szInstallPackage: PAnsiChar; // LPCSTR optional
eInstallType: Integer; // INSTALLTYPE
szCommandLine: PAnsiChar // LPCSTR optional
): DWORD; stdcall;
external 'msi.dll' name 'MsiApplyPatchA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "MsiApplyPatchA"
c_MsiApplyPatchA :: CString -> CString -> Int32 -> CString -> IO Word32
-- szPatchPackage : LPCSTR -> CString
-- szInstallPackage : LPCSTR optional -> CString
-- eInstallType : INSTALLTYPE -> Int32
-- szCommandLine : LPCSTR optional -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let msiapplypatcha =
foreign "MsiApplyPatchA"
(string @-> string @-> int32_t @-> string @-> returning uint32_t)
(* szPatchPackage : LPCSTR -> string *)
(* szInstallPackage : LPCSTR optional -> string *)
(* eInstallType : INSTALLTYPE -> int32_t *)
(* szCommandLine : LPCSTR optional -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)
(cffi:defcfun ("MsiApplyPatchA" msi-apply-patch-a :convention :stdcall) :uint32
(sz-patch-package :string) ; LPCSTR
(sz-install-package :string) ; LPCSTR optional
(e-install-type :int32) ; INSTALLTYPE
(sz-command-line :string)) ; LPCSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $MsiApplyPatchA = Win32::API::More->new('msi',
'DWORD MsiApplyPatchA(LPCSTR szPatchPackage, LPCSTR szInstallPackage, int eInstallType, LPCSTR szCommandLine)');
# my $ret = $MsiApplyPatchA->Call($szPatchPackage, $szInstallPackage, $eInstallType, $szCommandLine);
# szPatchPackage : LPCSTR -> LPCSTR
# szInstallPackage : LPCSTR optional -> LPCSTR
# eInstallType : INSTALLTYPE -> int
# szCommandLine : LPCSTR optional -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f MsiApplyPatchW (Unicode版) — 製品にパッチパッケージを適用する(Unicode版)。