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

MsiApplyMultiplePatchesA

関数
複数のパッチを一括して製品に適用する(ANSI版)。
DLLmsi.dll文字セットANSI (-A)呼出規約winapi対応OSwindows8.0

シグネチャ

// msi.dll  (ANSI / -A)
#include <windows.h>

DWORD MsiApplyMultiplePatchesA(
    LPCSTR szPatchPackages,
    LPCSTR szProductCode,   // optional
    LPCSTR szPropertiesList   // optional
);

パラメーター

名前方向説明
szPatchPackagesLPCSTRinパッチ ファイルへのパスをセミコロン区切りで列挙した 1 つの文字列。例: ""c:\sus\download\cache\Office\sp1.msp; c:\sus\download\cache\Office\QFE1.msp; c:\sus\download\cache\Office\QFEn.msp" "
szProductCodeLPCSTRinoptionalこのパラメーターは、パッチを適用する製品の ProductCode GUID です。MsiApplyMultiplePatches を呼び出すユーザーまたはアプリケーションには、パッチを適用する権限が必要です。このパラメーターが NULL の場合、パッチは適用可能なすべての製品に適用されます。このパラメーターが NULL 以外の場合、パッチは指定された製品にのみ適用されます。
szPropertiesListLPCSTRinoptional

製品のパッチ適用中に使用されるコマンド ライン プロパティ設定を指定する null 終端文字列。コマンド ライン プロパティ設定がない場合は、NULL ポインターを渡します。空文字列は無効なパラメーターです。これらのプロパティは、すべての対象製品で共有されます。詳細については、 About Properties および Setting Public Property Values on the Command Line を参照してください。

注意 プロパティ リストには PATCH プロパティを含めないでください。コマンド ラインで PATCH プロパティが設定されている場合、その値は無視され、適用されるパッチによって上書きされます。

戻り値の型: DWORD

公式ドキュメント

1 つ以上のパッチを、それらのパッチを適用可能な製品に適用します。(ANSI)

戻り値

MsiApplyMultiplePatches 関数は、次の値を返します。

意味
ERROR_INVALID_PARAMETER
渡された引数の一部が正しくないか、矛盾しています。
ERROR_SUCCESS
関数が完了し、すべての製品が正常にパッチ適用されました。ERROR_SUCCESS は、パッチを適用可能なすべての製品が正常にパッチ適用された場合にのみ返されます。新しいパッチがいずれも適用できない場合、MsiApplyMultiplePatchesERROR_SUCCESS を返し、製品の状態は変更されません。
ERROR_SUCCESS_REBOOT_INITIATED
直前のトランザクションによって開始された再起動により、この MsiApplyMultiplePatches の呼び出しが終了しました。すべての対象製品がパッチ適用されていない可能性があります。
ERROR_SUCCESS_REBOOT_REQUIRED
直前のトランザクションが要求した再起動により、この MsiApplyMultiplePatches の呼び出しが終了しました。すべての対象製品がパッチ適用されていない可能性があります。
ERROR_PATCH_PACKAGE_OPEN_FAILED
指定されたパッチ パッケージの 1 つを開けませんでした。
ERROR_PATCH_PACKAGE_INVALID
指定されたパッチ パッケージの 1 つが有効ではありません。
ERROR_PATCH_PACKAGE_UNSUPPORTED
パッチ パッケージの 1 つがサポートされていません。
Winerror.h 内の任意のエラー
部分的に完了した可能性、または 1 つ以上のトランザクションが失敗したことを示します。

解説(Remarks)

メモ

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

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

各言語での呼び出し定義

// msi.dll  (ANSI / -A)
#include <windows.h>

DWORD MsiApplyMultiplePatchesA(
    LPCSTR szPatchPackages,
    LPCSTR szProductCode,   // optional
    LPCSTR szPropertiesList   // optional
);
[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiApplyMultiplePatchesA(
    [MarshalAs(UnmanagedType.LPStr)] string szPatchPackages,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string szProductCode,   // LPCSTR optional
    [MarshalAs(UnmanagedType.LPStr)] string szPropertiesList   // LPCSTR optional
);
<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiApplyMultiplePatchesA(
    <MarshalAs(UnmanagedType.LPStr)> szPatchPackages As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> szProductCode As String,   ' LPCSTR optional
    <MarshalAs(UnmanagedType.LPStr)> szPropertiesList As String   ' LPCSTR optional
) As UInteger
End Function
' szPatchPackages : LPCSTR
' szProductCode : LPCSTR optional
' szPropertiesList : LPCSTR optional
Declare PtrSafe Function MsiApplyMultiplePatchesA Lib "msi" ( _
    ByVal szPatchPackages As String, _
    ByVal szProductCode As String, _
    ByVal szPropertiesList As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MsiApplyMultiplePatchesA = ctypes.windll.msi.MsiApplyMultiplePatchesA
MsiApplyMultiplePatchesA.restype = wintypes.DWORD
MsiApplyMultiplePatchesA.argtypes = [
    wintypes.LPCSTR,  # szPatchPackages : LPCSTR
    wintypes.LPCSTR,  # szProductCode : LPCSTR optional
    wintypes.LPCSTR,  # szPropertiesList : LPCSTR optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiApplyMultiplePatchesA = Fiddle::Function.new(
  lib['MsiApplyMultiplePatchesA'],
  [
    Fiddle::TYPE_VOIDP,  # szPatchPackages : LPCSTR
    Fiddle::TYPE_VOIDP,  # szProductCode : LPCSTR optional
    Fiddle::TYPE_VOIDP,  # szPropertiesList : LPCSTR optional
  ],
  -Fiddle::TYPE_INT)
#[link(name = "msi")]
extern "system" {
    fn MsiApplyMultiplePatchesA(
        szPatchPackages: *const u8,  // LPCSTR
        szProductCode: *const u8,  // LPCSTR optional
        szPropertiesList: *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 MsiApplyMultiplePatchesA([MarshalAs(UnmanagedType.LPStr)] string szPatchPackages, [MarshalAs(UnmanagedType.LPStr)] string szProductCode, [MarshalAs(UnmanagedType.LPStr)] string szPropertiesList);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiApplyMultiplePatchesA' -Namespace Win32 -PassThru
# $api::MsiApplyMultiplePatchesA(szPatchPackages, szProductCode, szPropertiesList)
#uselib "msi.dll"
#func global MsiApplyMultiplePatchesA "MsiApplyMultiplePatchesA" sptr, sptr, sptr
; MsiApplyMultiplePatchesA szPatchPackages, szProductCode, szPropertiesList   ; 戻り値は stat
; szPatchPackages : LPCSTR -> "sptr"
; szProductCode : LPCSTR optional -> "sptr"
; szPropertiesList : LPCSTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "msi.dll"
#cfunc global MsiApplyMultiplePatchesA "MsiApplyMultiplePatchesA" str, str, str
; res = MsiApplyMultiplePatchesA(szPatchPackages, szProductCode, szPropertiesList)
; szPatchPackages : LPCSTR -> "str"
; szProductCode : LPCSTR optional -> "str"
; szPropertiesList : LPCSTR optional -> "str"
; DWORD MsiApplyMultiplePatchesA(LPCSTR szPatchPackages, LPCSTR szProductCode, LPCSTR szPropertiesList)
#uselib "msi.dll"
#cfunc global MsiApplyMultiplePatchesA "MsiApplyMultiplePatchesA" str, str, str
; res = MsiApplyMultiplePatchesA(szPatchPackages, szProductCode, szPropertiesList)
; szPatchPackages : LPCSTR -> "str"
; szProductCode : LPCSTR optional -> "str"
; szPropertiesList : LPCSTR optional -> "str"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiApplyMultiplePatchesA = msi.NewProc("MsiApplyMultiplePatchesA")
)

// szPatchPackages (LPCSTR), szProductCode (LPCSTR optional), szPropertiesList (LPCSTR optional)
r1, _, err := procMsiApplyMultiplePatchesA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(szPatchPackages))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(szProductCode))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(szPropertiesList))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function MsiApplyMultiplePatchesA(
  szPatchPackages: PAnsiChar;   // LPCSTR
  szProductCode: PAnsiChar;   // LPCSTR optional
  szPropertiesList: PAnsiChar   // LPCSTR optional
): DWORD; stdcall;
  external 'msi.dll' name 'MsiApplyMultiplePatchesA';
result := DllCall("msi\MsiApplyMultiplePatchesA"
    , "AStr", szPatchPackages   ; LPCSTR
    , "AStr", szProductCode   ; LPCSTR optional
    , "AStr", szPropertiesList   ; LPCSTR optional
    , "UInt")   ; return: DWORD
●MsiApplyMultiplePatchesA(szPatchPackages, szProductCode, szPropertiesList) = DLL("msi.dll", "dword MsiApplyMultiplePatchesA(char*, char*, char*)")
# 呼び出し: MsiApplyMultiplePatchesA(szPatchPackages, szProductCode, szPropertiesList)
# szPatchPackages : LPCSTR -> "char*"
# szProductCode : LPCSTR optional -> "char*"
# szPropertiesList : LPCSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "msi" fn MsiApplyMultiplePatchesA(
    szPatchPackages: [*c]const u8, // LPCSTR
    szProductCode: [*c]const u8, // LPCSTR optional
    szPropertiesList: [*c]const u8 // LPCSTR optional
) callconv(std.os.windows.WINAPI) u32;
proc MsiApplyMultiplePatchesA(
    szPatchPackages: cstring,  # LPCSTR
    szProductCode: cstring,  # LPCSTR optional
    szPropertiesList: cstring  # LPCSTR optional
): uint32 {.importc: "MsiApplyMultiplePatchesA", stdcall, dynlib: "msi.dll".}
pragma(lib, "msi");
extern(Windows)
uint MsiApplyMultiplePatchesA(
    const(char)* szPatchPackages,   // LPCSTR
    const(char)* szProductCode,   // LPCSTR optional
    const(char)* szPropertiesList   // LPCSTR optional
);
ccall((:MsiApplyMultiplePatchesA, "msi.dll"), stdcall, UInt32,
      (Cstring, Cstring, Cstring),
      szPatchPackages, szProductCode, szPropertiesList)
# szPatchPackages : LPCSTR -> Cstring
# szProductCode : LPCSTR optional -> Cstring
# szPropertiesList : LPCSTR optional -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiApplyMultiplePatchesA(
    const char* szPatchPackages,
    const char* szProductCode,
    const char* szPropertiesList);
]]
local msi = ffi.load("msi")
-- msi.MsiApplyMultiplePatchesA(szPatchPackages, szProductCode, szPropertiesList)
-- szPatchPackages : LPCSTR
-- szProductCode : LPCSTR optional
-- szPropertiesList : LPCSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiApplyMultiplePatchesA = lib.func('__stdcall', 'MsiApplyMultiplePatchesA', 'uint32_t', ['str', 'str', 'str']);
// MsiApplyMultiplePatchesA(szPatchPackages, szProductCode, szPropertiesList)
// szPatchPackages : LPCSTR -> 'str'
// szProductCode : LPCSTR optional -> 'str'
// szPropertiesList : LPCSTR optional -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("msi.dll", {
  MsiApplyMultiplePatchesA: { parameters: ["buffer", "buffer", "buffer"], result: "u32" },
});
// lib.symbols.MsiApplyMultiplePatchesA(szPatchPackages, szProductCode, szPropertiesList)
// szPatchPackages : LPCSTR -> "buffer"
// szProductCode : LPCSTR optional -> "buffer"
// szPropertiesList : LPCSTR optional -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiApplyMultiplePatchesA(
    const char* szPatchPackages,
    const char* szProductCode,
    const char* szPropertiesList);
C, "msi.dll");
// $ffi->MsiApplyMultiplePatchesA(szPatchPackages, szProductCode, szPropertiesList);
// szPatchPackages : LPCSTR
// szProductCode : LPCSTR optional
// szPropertiesList : 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 MsiApplyMultiplePatchesA(
        String szPatchPackages,   // LPCSTR
        String szProductCode,   // LPCSTR optional
        String szPropertiesList   // LPCSTR optional
    );
}
@[Link("msi")]
lib Libmsi
  fun MsiApplyMultiplePatchesA = MsiApplyMultiplePatchesA(
    szPatchPackages : UInt8*,   # LPCSTR
    szProductCode : UInt8*,   # LPCSTR optional
    szPropertiesList : 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 MsiApplyMultiplePatchesANative = Uint32 Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>);
typedef MsiApplyMultiplePatchesADart = int Function(Pointer<Utf8>, Pointer<Utf8>, Pointer<Utf8>);
final MsiApplyMultiplePatchesA = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiApplyMultiplePatchesANative, MsiApplyMultiplePatchesADart>('MsiApplyMultiplePatchesA');
// szPatchPackages : LPCSTR -> Pointer<Utf8>
// szProductCode : LPCSTR optional -> Pointer<Utf8>
// szPropertiesList : LPCSTR optional -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiApplyMultiplePatchesA(
  szPatchPackages: PAnsiChar;   // LPCSTR
  szProductCode: PAnsiChar;   // LPCSTR optional
  szPropertiesList: PAnsiChar   // LPCSTR optional
): DWORD; stdcall;
  external 'msi.dll' name 'MsiApplyMultiplePatchesA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiApplyMultiplePatchesA"
  c_MsiApplyMultiplePatchesA :: CString -> CString -> CString -> IO Word32
-- szPatchPackages : LPCSTR -> CString
-- szProductCode : LPCSTR optional -> CString
-- szPropertiesList : LPCSTR optional -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msiapplymultiplepatchesa =
  foreign "MsiApplyMultiplePatchesA"
    (string @-> string @-> string @-> returning uint32_t)
(* szPatchPackages : LPCSTR -> string *)
(* szProductCode : LPCSTR optional -> string *)
(* szPropertiesList : 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 ("MsiApplyMultiplePatchesA" msi-apply-multiple-patches-a :convention :stdcall) :uint32
  (sz-patch-packages :string)   ; LPCSTR
  (sz-product-code :string)   ; LPCSTR optional
  (sz-properties-list :string))   ; LPCSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiApplyMultiplePatchesA = Win32::API::More->new('msi',
    'DWORD MsiApplyMultiplePatchesA(LPCSTR szPatchPackages, LPCSTR szProductCode, LPCSTR szPropertiesList)');
# my $ret = $MsiApplyMultiplePatchesA->Call($szPatchPackages, $szProductCode, $szPropertiesList);
# szPatchPackages : LPCSTR -> LPCSTR
# szProductCode : LPCSTR optional -> LPCSTR
# szPropertiesList : LPCSTR optional -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い