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

MsiSourceListClearAllExA

関数
コンテキストやオプションを指定してソースリストを一括削除する。
DLLmsi.dll文字セットANSI (-A)呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD MsiSourceListClearAllExA(
    LPCSTR szProductCodeOrPatchCode,
    LPCSTR szUserSid,   // optional
    MSIINSTALLCONTEXT dwContext,
    DWORD dwOptions
);

パラメーター

名前方向説明
szProductCodeOrPatchCodeLPCSTRin製品またはパッチの ProductCode またはパッチ GUID です。null で終わる文字列を使用します。文字列が 39 文字より長い場合、関数は失敗し ERROR_INVALID_PARAMETER を返します。このパラメーターを NULL にすることはできません。
szUserSidLPCSTRinoptionalこのパラメーターには、製品またはパッチを保持するユーザーアカウントを指定する文字列 SID を指定できます。SID は検証も解決もされません。不正な SID を指定すると ERROR_UNKNOWN_PRODUCT または ERROR_UNKNOWN_PATCH が返されることがあります。マシンコンテキストを参照する場合、szUserSIDNULL でなければならず、dwContextMSIINSTALLCONTEXT_MACHINE でなければなりません。マシン SID("S-1-5-18")を使用すると ERROR_INVALID PARAMETER が返されます。現在のユーザーアカウントを参照する場合、szUserSIDNULL にでき、dwContextMSIINSTALLCONTEXT_USERMANAGED または MSIINSTALLCONTEXT_USERUNMANAGED にできます。
dwContextMSIINSTALLCONTEXTin

このパラメーターは、製品またはパッチのインスタンスのコンテキストを指定します。このパラメーターには次のいずれかの値を指定できます。

コンテキストの種類 意味
MSIINSTALLCONTEXT_USERMANAGED
製品またはパッチのインスタンスが、ユーザー単位の管理対象(per-user-managed)コンテキストに存在します。
MSIINSTALLCONTEXT_USERUNMANAGED
製品またはパッチのインスタンスが、ユーザー単位の非管理対象(per-user-unmanaged)コンテキストに存在します。
MSIINSTALLCONTEXT_MACHINE
製品またはパッチのインスタンスが、マシン単位(per-machine)コンテキストに存在します。
dwOptionsDWORDin

dwOptions の値によって、szProductCodeOrPatchCode の値の解釈方法と、クリアするソースの種類が決まります。このパラメーターは、次の MSISOURCETYPE_* 定数のいずれか 1 つと、次の MSICODE_* 定数のいずれか 1 つを組み合わせて指定する必要があります。

フラグ 意味
MSISOURCETYPE_MEDIA
ソースはメディアです。
MSISOURCETYPE_NETWORK
ソースはネットワークタイプです。
MSISOURCETYPE_URL
ソースは URL タイプです。
MSICODE_PATCH
szProductCodeOrPatchCode はパッチコードです。
MSICODE_PRODUCT
szProductCodeOrPatchCode は製品コードです。

戻り値の型: DWORD

公式ドキュメント

MsiSourceListClearAllEx 関数は、指定した製品またはパッチのインスタンスについて、特定のソースタイプの既存ソースをすべて削除します。(ANSI)

戻り値

意味
ERROR_ACCESS_DENIED
ユーザーにソースを追加または移動する権限がありません。製品またはパッチが見つかったかどうかは示しません。
ERROR_BAD_CONFIGURATION
構成データが破損しています。
ERROR_INSTALL_SERVICE_FAILURE
Windows Installer サービスにアクセスできません。
ERROR_INVALID_PARAMETER
無効なパラメーターが関数に渡されました。
ERROR_SUCCESS
指定したタイプのソースがすべて削除されました。
ERROR_UNKNOWN_PRODUCT
指定した製品は不明です。
ERROR_UNKNOWN_PATCH
指定したパッチは不明です。
ERROR_FUNCTION_FAILED
予期しない内部エラーが発生しました。

解説(Remarks)

管理者は、マシンコンテキストに存在する製品またはパッチのインスタンス、あるいは自分自身のユーザー単位(管理対象または非管理対象)コンテキストに存在する製品またはパッチのインスタンスのインストールを変更できます。また、任意のユーザーのユーザー単位の管理対象コンテキストに存在する製品またはパッチのインスタンスのインストールを変更できます。ただし、別のユーザーのユーザー単位の非管理対象コンテキストに存在する、そのユーザーの製品またはパッチのインスタンスのインストールを変更することはできません。

非管理者は、別のユーザーのユーザー単位(管理対象または非管理対象)コンテキストに存在する製品またはパッチのインスタンスのインストールを変更できません。自分自身のユーザー単位の非管理対象コンテキストに存在する製品またはパッチのインスタンスのインストールは変更できます。マシンコンテキストまたは自分自身のユーザー単位の管理対象コンテキストに存在する製品またはパッチのインスタンスのインストールは、製品またはパッチのソースを参照(ブラウズ)する権限が付与されている場合に限り変更できます。ユーザーにソースの参照を許可するにはポリシーを設定します。詳細については、DisableBrowseAllowLockdownBrowseAlwaysInstallElevated の各ポリシーを参照してください。

メモ

msi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に応じて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして MsiSourceListClearAllEx を定義します。エンコーディング中立のエイリアスの使用と、エンコーディング中立でないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、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 MsiSourceListClearAllExA(
    LPCSTR szProductCodeOrPatchCode,
    LPCSTR szUserSid,   // optional
    MSIINSTALLCONTEXT dwContext,
    DWORD dwOptions
);
[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiSourceListClearAllExA(
    [MarshalAs(UnmanagedType.LPStr)] string szProductCodeOrPatchCode,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string szUserSid,   // LPCSTR optional
    int dwContext,   // MSIINSTALLCONTEXT
    uint dwOptions   // DWORD
);
<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiSourceListClearAllExA(
    <MarshalAs(UnmanagedType.LPStr)> szProductCodeOrPatchCode As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> szUserSid As String,   ' LPCSTR optional
    dwContext As Integer,   ' MSIINSTALLCONTEXT
    dwOptions As UInteger   ' DWORD
) As UInteger
End Function
' szProductCodeOrPatchCode : LPCSTR
' szUserSid : LPCSTR optional
' dwContext : MSIINSTALLCONTEXT
' dwOptions : DWORD
Declare PtrSafe Function MsiSourceListClearAllExA Lib "msi" ( _
    ByVal szProductCodeOrPatchCode As String, _
    ByVal szUserSid As String, _
    ByVal dwContext As Long, _
    ByVal dwOptions As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MsiSourceListClearAllExA = ctypes.windll.msi.MsiSourceListClearAllExA
MsiSourceListClearAllExA.restype = wintypes.DWORD
MsiSourceListClearAllExA.argtypes = [
    wintypes.LPCSTR,  # szProductCodeOrPatchCode : LPCSTR
    wintypes.LPCSTR,  # szUserSid : LPCSTR optional
    ctypes.c_int,  # dwContext : MSIINSTALLCONTEXT
    wintypes.DWORD,  # dwOptions : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiSourceListClearAllExA = Fiddle::Function.new(
  lib['MsiSourceListClearAllExA'],
  [
    Fiddle::TYPE_VOIDP,  # szProductCodeOrPatchCode : LPCSTR
    Fiddle::TYPE_VOIDP,  # szUserSid : LPCSTR optional
    Fiddle::TYPE_INT,  # dwContext : MSIINSTALLCONTEXT
    -Fiddle::TYPE_INT,  # dwOptions : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "msi")]
extern "system" {
    fn MsiSourceListClearAllExA(
        szProductCodeOrPatchCode: *const u8,  // LPCSTR
        szUserSid: *const u8,  // LPCSTR optional
        dwContext: i32,  // MSIINSTALLCONTEXT
        dwOptions: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Ansi)]
public static extern uint MsiSourceListClearAllExA([MarshalAs(UnmanagedType.LPStr)] string szProductCodeOrPatchCode, [MarshalAs(UnmanagedType.LPStr)] string szUserSid, int dwContext, uint dwOptions);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiSourceListClearAllExA' -Namespace Win32 -PassThru
# $api::MsiSourceListClearAllExA(szProductCodeOrPatchCode, szUserSid, dwContext, dwOptions)
#uselib "msi.dll"
#func global MsiSourceListClearAllExA "MsiSourceListClearAllExA" sptr, sptr, sptr, sptr
; MsiSourceListClearAllExA szProductCodeOrPatchCode, szUserSid, dwContext, dwOptions   ; 戻り値は stat
; szProductCodeOrPatchCode : LPCSTR -> "sptr"
; szUserSid : LPCSTR optional -> "sptr"
; dwContext : MSIINSTALLCONTEXT -> "sptr"
; dwOptions : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "msi.dll"
#cfunc global MsiSourceListClearAllExA "MsiSourceListClearAllExA" str, str, int, int
; res = MsiSourceListClearAllExA(szProductCodeOrPatchCode, szUserSid, dwContext, dwOptions)
; szProductCodeOrPatchCode : LPCSTR -> "str"
; szUserSid : LPCSTR optional -> "str"
; dwContext : MSIINSTALLCONTEXT -> "int"
; dwOptions : DWORD -> "int"
; DWORD MsiSourceListClearAllExA(LPCSTR szProductCodeOrPatchCode, LPCSTR szUserSid, MSIINSTALLCONTEXT dwContext, DWORD dwOptions)
#uselib "msi.dll"
#cfunc global MsiSourceListClearAllExA "MsiSourceListClearAllExA" str, str, int, int
; res = MsiSourceListClearAllExA(szProductCodeOrPatchCode, szUserSid, dwContext, dwOptions)
; szProductCodeOrPatchCode : LPCSTR -> "str"
; szUserSid : LPCSTR optional -> "str"
; dwContext : MSIINSTALLCONTEXT -> "int"
; dwOptions : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiSourceListClearAllExA = msi.NewProc("MsiSourceListClearAllExA")
)

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

extern "msi" fn MsiSourceListClearAllExA(
    szProductCodeOrPatchCode: [*c]const u8, // LPCSTR
    szUserSid: [*c]const u8, // LPCSTR optional
    dwContext: i32, // MSIINSTALLCONTEXT
    dwOptions: u32 // DWORD
) callconv(std.os.windows.WINAPI) u32;
proc MsiSourceListClearAllExA(
    szProductCodeOrPatchCode: cstring,  # LPCSTR
    szUserSid: cstring,  # LPCSTR optional
    dwContext: int32,  # MSIINSTALLCONTEXT
    dwOptions: uint32  # DWORD
): uint32 {.importc: "MsiSourceListClearAllExA", stdcall, dynlib: "msi.dll".}
pragma(lib, "msi");
extern(Windows)
uint MsiSourceListClearAllExA(
    const(char)* szProductCodeOrPatchCode,   // LPCSTR
    const(char)* szUserSid,   // LPCSTR optional
    int dwContext,   // MSIINSTALLCONTEXT
    uint dwOptions   // DWORD
);
ccall((:MsiSourceListClearAllExA, "msi.dll"), stdcall, UInt32,
      (Cstring, Cstring, Int32, UInt32),
      szProductCodeOrPatchCode, szUserSid, dwContext, dwOptions)
# szProductCodeOrPatchCode : LPCSTR -> Cstring
# szUserSid : LPCSTR optional -> Cstring
# dwContext : MSIINSTALLCONTEXT -> Int32
# dwOptions : DWORD -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiSourceListClearAllExA(
    const char* szProductCodeOrPatchCode,
    const char* szUserSid,
    int32_t dwContext,
    uint32_t dwOptions);
]]
local msi = ffi.load("msi")
-- msi.MsiSourceListClearAllExA(szProductCodeOrPatchCode, szUserSid, dwContext, dwOptions)
-- szProductCodeOrPatchCode : LPCSTR
-- szUserSid : LPCSTR optional
-- dwContext : MSIINSTALLCONTEXT
-- dwOptions : DWORD
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiSourceListClearAllExA = lib.func('__stdcall', 'MsiSourceListClearAllExA', 'uint32_t', ['str', 'str', 'int32_t', 'uint32_t']);
// MsiSourceListClearAllExA(szProductCodeOrPatchCode, szUserSid, dwContext, dwOptions)
// szProductCodeOrPatchCode : LPCSTR -> 'str'
// szUserSid : LPCSTR optional -> 'str'
// dwContext : MSIINSTALLCONTEXT -> 'int32_t'
// dwOptions : DWORD -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("msi.dll", {
  MsiSourceListClearAllExA: { parameters: ["buffer", "buffer", "i32", "u32"], result: "u32" },
});
// lib.symbols.MsiSourceListClearAllExA(szProductCodeOrPatchCode, szUserSid, dwContext, dwOptions)
// szProductCodeOrPatchCode : LPCSTR -> "buffer"
// szUserSid : LPCSTR optional -> "buffer"
// dwContext : MSIINSTALLCONTEXT -> "i32"
// dwOptions : DWORD -> "u32"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiSourceListClearAllExA(
    const char* szProductCodeOrPatchCode,
    const char* szUserSid,
    int32_t dwContext,
    uint32_t dwOptions);
C, "msi.dll");
// $ffi->MsiSourceListClearAllExA(szProductCodeOrPatchCode, szUserSid, dwContext, dwOptions);
// szProductCodeOrPatchCode : LPCSTR
// szUserSid : LPCSTR optional
// dwContext : MSIINSTALLCONTEXT
// dwOptions : DWORD
// 構造体/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 MsiSourceListClearAllExA(
        String szProductCodeOrPatchCode,   // LPCSTR
        String szUserSid,   // LPCSTR optional
        int dwContext,   // MSIINSTALLCONTEXT
        int dwOptions   // DWORD
    );
}
@[Link("msi")]
lib Libmsi
  fun MsiSourceListClearAllExA = MsiSourceListClearAllExA(
    szProductCodeOrPatchCode : UInt8*,   # LPCSTR
    szUserSid : UInt8*,   # LPCSTR optional
    dwContext : Int32,   # MSIINSTALLCONTEXT
    dwOptions : UInt32   # DWORD
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef MsiSourceListClearAllExANative = Uint32 Function(Pointer<Utf8>, Pointer<Utf8>, Int32, Uint32);
typedef MsiSourceListClearAllExADart = int Function(Pointer<Utf8>, Pointer<Utf8>, int, int);
final MsiSourceListClearAllExA = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiSourceListClearAllExANative, MsiSourceListClearAllExADart>('MsiSourceListClearAllExA');
// szProductCodeOrPatchCode : LPCSTR -> Pointer<Utf8>
// szUserSid : LPCSTR optional -> Pointer<Utf8>
// dwContext : MSIINSTALLCONTEXT -> Int32
// dwOptions : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiSourceListClearAllExA(
  szProductCodeOrPatchCode: PAnsiChar;   // LPCSTR
  szUserSid: PAnsiChar;   // LPCSTR optional
  dwContext: Integer;   // MSIINSTALLCONTEXT
  dwOptions: DWORD   // DWORD
): DWORD; stdcall;
  external 'msi.dll' name 'MsiSourceListClearAllExA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiSourceListClearAllExA"
  c_MsiSourceListClearAllExA :: CString -> CString -> Int32 -> Word32 -> IO Word32
-- szProductCodeOrPatchCode : LPCSTR -> CString
-- szUserSid : LPCSTR optional -> CString
-- dwContext : MSIINSTALLCONTEXT -> Int32
-- dwOptions : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msisourcelistclearallexa =
  foreign "MsiSourceListClearAllExA"
    (string @-> string @-> int32_t @-> uint32_t @-> returning uint32_t)
(* szProductCodeOrPatchCode : LPCSTR -> string *)
(* szUserSid : LPCSTR optional -> string *)
(* dwContext : MSIINSTALLCONTEXT -> int32_t *)
(* dwOptions : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)

(cffi:defcfun ("MsiSourceListClearAllExA" msi-source-list-clear-all-ex-a :convention :stdcall) :uint32
  (sz-product-code-or-patch-code :string)   ; LPCSTR
  (sz-user-sid :string)   ; LPCSTR optional
  (dw-context :int32)   ; MSIINSTALLCONTEXT
  (dw-options :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiSourceListClearAllExA = Win32::API::More->new('msi',
    'DWORD MsiSourceListClearAllExA(LPCSTR szProductCodeOrPatchCode, LPCSTR szUserSid, int dwContext, DWORD dwOptions)');
# my $ret = $MsiSourceListClearAllExA->Call($szProductCodeOrPatchCode, $szUserSid, $dwContext, $dwOptions);
# szProductCodeOrPatchCode : LPCSTR -> LPCSTR
# szUserSid : LPCSTR optional -> LPCSTR
# dwContext : MSIINSTALLCONTEXT -> int
# dwOptions : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

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