ホーム › System.ApplicationInstallationAndServicing › MsiRemovePatchesA
MsiRemovePatchesA
関数製品から指定のパッチを削除する(ANSI版)。
シグネチャ
// msi.dll (ANSI / -A)
#include <windows.h>
DWORD MsiRemovePatchesA(
LPCSTR szPatchList,
LPCSTR szProductCode,
INSTALLTYPE eUninstallType,
LPCSTR szPropertyList // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||
|---|---|---|---|---|---|---|---|
| szPatchList | LPCSTR | in | 削除するパッチの一覧を表す null 終端文字列です。各パッチは、パッチの GUID またはパッチ パッケージへのフルパスで指定できます。一覧内のパッチはセミコロンで区切ります。 | ||||
| szProductCode | LPCSTR | in | パッチを削除する対象製品の ProductCode (GUID) を表す null 終端文字列です。このパラメーターを NULL にすることはできません。 | ||||
| eUninstallType | INSTALLTYPE | in | 実行するパッチ削除の種類を示す値です。このパラメーターは INSTALLTYPE_SINGLE_INSTANCE である必要があります。
| ||||
| szPropertyList | LPCSTR | inoptional | コマンドライン プロパティ設定を指定する null 終端文字列です。詳細については、 About Properties および Setting Public Property Values on the Command Line を参照してください。このパラメーターは NULL にできます。 |
戻り値の型: DWORD
公式ドキュメント
1 つの製品から 1 つ以上のパッチを削除します。(ANSI)
戻り値
MsiRemovePatches 関数は次の値を返します。
| 値 | 意味 |
|---|---|
| 無効なパラメーターが含まれていました。 | |
| パッチ パッケージを開けませんでした。 | |
| パッチが正常に削除されました。 | |
| szProductList で指定された製品が、MsiRemovePatches の呼び出し元に対してコンピューター単位でもユーザー単位でもインストールされていません。 | |
| パッチ パッケージを開けませんでした。 | |
| パッチ パッケージが無効です。 | |
| このバージョンの Windows Installer サービスではパッチ パッケージを処理できません。 | |
| パッチ パッケージは削除できません。 | |
| パッチがこの製品に適用されていません。 | |
| ポリシーによってパッチの削除が許可されていません。 |
解説(Remarks)
ユーザーが利用できるすべての製品からアプリケーションがパッチを削除する方法を示す例については、Uninstalling Patches を参照してください。
メモ
msi.h ヘッダーは MsiRemovePatches を、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 (ANSI / -A)
#include <windows.h>
DWORD MsiRemovePatchesA(
LPCSTR szPatchList,
LPCSTR szProductCode,
INSTALLTYPE eUninstallType,
LPCSTR szPropertyList // optional
);[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiRemovePatchesA(
[MarshalAs(UnmanagedType.LPStr)] string szPatchList, // LPCSTR
[MarshalAs(UnmanagedType.LPStr)] string szProductCode, // LPCSTR
int eUninstallType, // INSTALLTYPE
[MarshalAs(UnmanagedType.LPStr)] string szPropertyList // LPCSTR optional
);<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiRemovePatchesA(
<MarshalAs(UnmanagedType.LPStr)> szPatchList As String, ' LPCSTR
<MarshalAs(UnmanagedType.LPStr)> szProductCode As String, ' LPCSTR
eUninstallType As Integer, ' INSTALLTYPE
<MarshalAs(UnmanagedType.LPStr)> szPropertyList As String ' LPCSTR optional
) As UInteger
End Function' szPatchList : LPCSTR
' szProductCode : LPCSTR
' eUninstallType : INSTALLTYPE
' szPropertyList : LPCSTR optional
Declare PtrSafe Function MsiRemovePatchesA Lib "msi" ( _
ByVal szPatchList As String, _
ByVal szProductCode As String, _
ByVal eUninstallType As Long, _
ByVal szPropertyList As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。import ctypes
from ctypes import wintypes
MsiRemovePatchesA = ctypes.windll.msi.MsiRemovePatchesA
MsiRemovePatchesA.restype = wintypes.DWORD
MsiRemovePatchesA.argtypes = [
wintypes.LPCSTR, # szPatchList : LPCSTR
wintypes.LPCSTR, # szProductCode : LPCSTR
ctypes.c_int, # eUninstallType : INSTALLTYPE
wintypes.LPCSTR, # szPropertyList : LPCSTR optional
]require 'fiddle'
require 'fiddle/import'
lib = Fiddle.dlopen('msi.dll')
MsiRemovePatchesA = Fiddle::Function.new(
lib['MsiRemovePatchesA'],
[
Fiddle::TYPE_VOIDP, # szPatchList : LPCSTR
Fiddle::TYPE_VOIDP, # szProductCode : LPCSTR
Fiddle::TYPE_INT, # eUninstallType : INSTALLTYPE
Fiddle::TYPE_VOIDP, # szPropertyList : LPCSTR optional
],
-Fiddle::TYPE_INT)#[link(name = "msi")]
extern "system" {
fn MsiRemovePatchesA(
szPatchList: *const u8, // LPCSTR
szProductCode: *const u8, // LPCSTR
eUninstallType: i32, // INSTALLTYPE
szPropertyList: *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 MsiRemovePatchesA([MarshalAs(UnmanagedType.LPStr)] string szPatchList, [MarshalAs(UnmanagedType.LPStr)] string szProductCode, int eUninstallType, [MarshalAs(UnmanagedType.LPStr)] string szPropertyList);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiRemovePatchesA' -Namespace Win32 -PassThru
# $api::MsiRemovePatchesA(szPatchList, szProductCode, eUninstallType, szPropertyList)#uselib "msi.dll"
#func global MsiRemovePatchesA "MsiRemovePatchesA" sptr, sptr, sptr, sptr
; MsiRemovePatchesA szPatchList, szProductCode, eUninstallType, szPropertyList ; 戻り値は stat
; szPatchList : LPCSTR -> "sptr"
; szProductCode : LPCSTR -> "sptr"
; eUninstallType : INSTALLTYPE -> "sptr"
; szPropertyList : LPCSTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。#uselib "msi.dll"
#cfunc global MsiRemovePatchesA "MsiRemovePatchesA" str, str, int, str
; res = MsiRemovePatchesA(szPatchList, szProductCode, eUninstallType, szPropertyList)
; szPatchList : LPCSTR -> "str"
; szProductCode : LPCSTR -> "str"
; eUninstallType : INSTALLTYPE -> "int"
; szPropertyList : LPCSTR optional -> "str"; DWORD MsiRemovePatchesA(LPCSTR szPatchList, LPCSTR szProductCode, INSTALLTYPE eUninstallType, LPCSTR szPropertyList)
#uselib "msi.dll"
#cfunc global MsiRemovePatchesA "MsiRemovePatchesA" str, str, int, str
; res = MsiRemovePatchesA(szPatchList, szProductCode, eUninstallType, szPropertyList)
; szPatchList : LPCSTR -> "str"
; szProductCode : LPCSTR -> "str"
; eUninstallType : INSTALLTYPE -> "int"
; szPropertyList : LPCSTR optional -> "str"import (
"golang.org/x/sys/windows"
"unsafe"
)
var (
msi = windows.NewLazySystemDLL("msi.dll")
procMsiRemovePatchesA = msi.NewProc("MsiRemovePatchesA")
)
// szPatchList (LPCSTR), szProductCode (LPCSTR), eUninstallType (INSTALLTYPE), szPropertyList (LPCSTR optional)
r1, _, err := procMsiRemovePatchesA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(szPatchList))),
uintptr(unsafe.Pointer(windows.BytePtrFromString(szProductCode))),
uintptr(eUninstallType),
uintptr(unsafe.Pointer(windows.BytePtrFromString(szPropertyList))),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction MsiRemovePatchesA(
szPatchList: PAnsiChar; // LPCSTR
szProductCode: PAnsiChar; // LPCSTR
eUninstallType: Integer; // INSTALLTYPE
szPropertyList: PAnsiChar // LPCSTR optional
): DWORD; stdcall;
external 'msi.dll' name 'MsiRemovePatchesA';result := DllCall("msi\MsiRemovePatchesA"
, "AStr", szPatchList ; LPCSTR
, "AStr", szProductCode ; LPCSTR
, "Int", eUninstallType ; INSTALLTYPE
, "AStr", szPropertyList ; LPCSTR optional
, "UInt") ; return: DWORD●MsiRemovePatchesA(szPatchList, szProductCode, eUninstallType, szPropertyList) = DLL("msi.dll", "dword MsiRemovePatchesA(char*, char*, int, char*)")
# 呼び出し: MsiRemovePatchesA(szPatchList, szProductCode, eUninstallType, szPropertyList)
# szPatchList : LPCSTR -> "char*"
# szProductCode : LPCSTR -> "char*"
# eUninstallType : INSTALLTYPE -> "int"
# szPropertyList : LPCSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。const std = @import("std");
extern "msi" fn MsiRemovePatchesA(
szPatchList: [*c]const u8, // LPCSTR
szProductCode: [*c]const u8, // LPCSTR
eUninstallType: i32, // INSTALLTYPE
szPropertyList: [*c]const u8 // LPCSTR optional
) callconv(std.os.windows.WINAPI) u32;proc MsiRemovePatchesA(
szPatchList: cstring, # LPCSTR
szProductCode: cstring, # LPCSTR
eUninstallType: int32, # INSTALLTYPE
szPropertyList: cstring # LPCSTR optional
): uint32 {.importc: "MsiRemovePatchesA", stdcall, dynlib: "msi.dll".}pragma(lib, "msi");
extern(Windows)
uint MsiRemovePatchesA(
const(char)* szPatchList, // LPCSTR
const(char)* szProductCode, // LPCSTR
int eUninstallType, // INSTALLTYPE
const(char)* szPropertyList // LPCSTR optional
);ccall((:MsiRemovePatchesA, "msi.dll"), stdcall, UInt32,
(Cstring, Cstring, Int32, Cstring),
szPatchList, szProductCode, eUninstallType, szPropertyList)
# szPatchList : LPCSTR -> Cstring
# szProductCode : LPCSTR -> Cstring
# eUninstallType : INSTALLTYPE -> Int32
# szPropertyList : LPCSTR optional -> Cstring
# stdcall は 32bit のみ意味を持つ(x64 では無視)。local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiRemovePatchesA(
const char* szPatchList,
const char* szProductCode,
int32_t eUninstallType,
const char* szPropertyList);
]]
local msi = ffi.load("msi")
-- msi.MsiRemovePatchesA(szPatchList, szProductCode, eUninstallType, szPropertyList)
-- szPatchList : LPCSTR
-- szProductCode : LPCSTR
-- eUninstallType : INSTALLTYPE
-- szPropertyList : LPCSTR optional
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiRemovePatchesA = lib.func('__stdcall', 'MsiRemovePatchesA', 'uint32_t', ['str', 'str', 'int32_t', 'str']);
// MsiRemovePatchesA(szPatchList, szProductCode, eUninstallType, szPropertyList)
// szPatchList : LPCSTR -> 'str'
// szProductCode : LPCSTR -> 'str'
// eUninstallType : INSTALLTYPE -> 'int32_t'
// szPropertyList : LPCSTR optional -> 'str'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。const lib = Deno.dlopen("msi.dll", {
MsiRemovePatchesA: { parameters: ["buffer", "buffer", "i32", "buffer"], result: "u32" },
});
// lib.symbols.MsiRemovePatchesA(szPatchList, szProductCode, eUninstallType, szPropertyList)
// szPatchList : LPCSTR -> "buffer"
// szProductCode : LPCSTR -> "buffer"
// eUninstallType : INSTALLTYPE -> "i32"
// szPropertyList : LPCSTR optional -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiRemovePatchesA(
const char* szPatchList,
const char* szProductCode,
int32_t eUninstallType,
const char* szPropertyList);
C, "msi.dll");
// $ffi->MsiRemovePatchesA(szPatchList, szProductCode, eUninstallType, szPropertyList);
// szPatchList : LPCSTR
// szProductCode : LPCSTR
// eUninstallType : INSTALLTYPE
// szPropertyList : 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 MsiRemovePatchesA(
String szPatchList, // LPCSTR
String szProductCode, // LPCSTR
int eUninstallType, // INSTALLTYPE
String szPropertyList // LPCSTR optional
);
}@[Link("msi")]
lib Libmsi
fun MsiRemovePatchesA = MsiRemovePatchesA(
szPatchList : UInt8*, # LPCSTR
szProductCode : UInt8*, # LPCSTR
eUninstallType : Int32, # INSTALLTYPE
szPropertyList : 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 MsiRemovePatchesANative = Uint32 Function(Pointer<Utf8>, Pointer<Utf8>, Int32, Pointer<Utf8>);
typedef MsiRemovePatchesADart = int Function(Pointer<Utf8>, Pointer<Utf8>, int, Pointer<Utf8>);
final MsiRemovePatchesA = DynamicLibrary.open('msi.dll')
.lookupFunction<MsiRemovePatchesANative, MsiRemovePatchesADart>('MsiRemovePatchesA');
// szPatchList : LPCSTR -> Pointer<Utf8>
// szProductCode : LPCSTR -> Pointer<Utf8>
// eUninstallType : INSTALLTYPE -> Int32
// szPropertyList : LPCSTR optional -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。{$mode objfpc}{$H+}
function MsiRemovePatchesA(
szPatchList: PAnsiChar; // LPCSTR
szProductCode: PAnsiChar; // LPCSTR
eUninstallType: Integer; // INSTALLTYPE
szPropertyList: PAnsiChar // LPCSTR optional
): DWORD; stdcall;
external 'msi.dll' name 'MsiRemovePatchesA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "MsiRemovePatchesA"
c_MsiRemovePatchesA :: CString -> CString -> Int32 -> CString -> IO Word32
-- szPatchList : LPCSTR -> CString
-- szProductCode : LPCSTR -> CString
-- eUninstallType : INSTALLTYPE -> Int32
-- szPropertyList : LPCSTR optional -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。open Ctypes
open Foreign
let msiremovepatchesa =
foreign "MsiRemovePatchesA"
(string @-> string @-> int32_t @-> string @-> returning uint32_t)
(* szPatchList : LPCSTR -> string *)
(* szProductCode : LPCSTR -> string *)
(* eUninstallType : INSTALLTYPE -> int32_t *)
(* szPropertyList : 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 ("MsiRemovePatchesA" msi-remove-patches-a :convention :stdcall) :uint32
(sz-patch-list :string) ; LPCSTR
(sz-product-code :string) ; LPCSTR
(e-uninstall-type :int32) ; INSTALLTYPE
(sz-property-list :string)) ; LPCSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。use Win32::API;
my $MsiRemovePatchesA = Win32::API::More->new('msi',
'DWORD MsiRemovePatchesA(LPCSTR szPatchList, LPCSTR szProductCode, int eUninstallType, LPCSTR szPropertyList)');
# my $ret = $MsiRemovePatchesA->Call($szPatchList, $szProductCode, $eUninstallType, $szPropertyList);
# szPatchList : LPCSTR -> LPCSTR
# szProductCode : LPCSTR -> LPCSTR
# eUninstallType : INSTALLTYPE -> int
# szPropertyList : LPCSTR optional -> LPCSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
文字セット違い
- f MsiRemovePatchesW (Unicode版) — 製品から指定のパッチを削除する(Unicode版)。
公式の関連項目
- f MsiApplyPatchA — 製品にパッチパッケージを適用する(ANSI版)。
使用する型