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

MsiSourceListClearAllW

関数
製品のネットワークソースリストをすべて削除する。
DLLmsi.dll文字セットUnicode (-W)呼出規約winapi対応OSwindows8.0

シグネチャ

// msi.dll  (Unicode / -W)
#include <windows.h>

DWORD MsiSourceListClearAllW(
    LPCWSTR szProduct,
    LPCWSTR szUserName,   // optional
    DWORD dwReserved   // optional
);

パラメーター

名前方向説明
szProductLPCWSTRin変更する製品の ProductCode
szUserNameLPCWSTRinoptional

ユーザー単位インストールのユーザー名。ユーザー名は常に DOMAIN\USERNAME(ローカルユーザーの場合は MACHINENAME\USERNAME)の形式で指定する必要があります。

マシン単位インストールの場合は空文字列または NULL を指定します。

dwReservedDWORDoptional将来の使用のために予約されています。この値は 0 に設定する必要があります。

戻り値の型: DWORD

公式ドキュメント

MsiSourceListClearAll 関数は、指定されたコンテキストにおいて、パッチまたは製品のソースリストからすべてのネットワークソースを削除します。詳細については、「Source Resiliency」を参照してください。(Unicode)

戻り値

MsiSourceListClearAll 関数は以下の値を返します。

意味
ERROR_ACCESS_DENIED
ユーザーにこの製品のソースリストをクリアする権限がありません。
ERROR_BAD_CONFIGURATION
構成データが破損しています。
ERROR_BAD_USERNAME
ユーザー名を解決できませんでした。
ERROR_FUNCTION_FAILED
関数が成功しませんでした。
ERROR_INSTALL_SERVICE_FAILURE
インストーラーサービスにアクセスできませんでした。
ERROR_INVALID_PARAMETER
無効なパラメーターが関数に渡されました。
ERROR_SUCCESS
関数が成功しました。
ERROR_UNKNOWN_PRODUCT
指定された製品は不明です。

解説(Remarks)

管理者は、マシン単位インストール、自分自身のユーザー単位の非管理対象インストール、および任意のユーザーのユーザー単位の管理対象インストールを変更できます。管理者以外のユーザーは、マシン単位インストールと自分自身の(管理対象または非管理対象の)ユーザー単位インストールのみを変更できます。ポリシーを設定することで、ユーザーがソースを参照できるようにすることができます。詳細については、DisableBrowseAllowLockdownBrowse、および AlwaysInstallElevated の各ポリシーを参照してください。

ネットワークソースが製品の現在のソースである場合、この関数は、次にソースが必要になったときに、インストーラーに有効なソースをソースリストから検索させます。現在のソースがメディアまたは URL ソースである場合、この呼び出しの後も引き続き有効であり、MsiSourceListForceResolution も呼び出されない限り、ソースリストは検索されません。

ユーザー名が空文字列または NULL の場合、関数は製品のマシン単位インストールに対して動作します。この場合、製品がユーザー単位のみでインストールされていると、関数は ERROR_UNKNOWN_PRODUCT を返します。

ユーザー名が空文字列または NULL でない場合は、製品インストールを変更するユーザーの名前を指定します。ユーザー名が現在のユーザー名である場合、関数はまず製品の非管理対象インストールの変更を試みます。製品の非管理対象インストールが見つからない場合、関数は次に管理対象のユーザー単位インストールの変更を試みます。製品の管理対象または非管理対象のユーザー単位インストールが見つからない場合、製品がマシン単位でインストールされていても、関数は ERROR_UNKNOWN_PRODUCT を返します。

この関数は、現在のユーザー以外のユーザーの非管理対象インストールを変更できません。ユーザー名が空文字列または NULL ではないが現在のユーザーでない場合、関数は指定されたユーザーに対する製品の管理対象ユーザー単位インストールのみを確認します。指定されたユーザーに対して製品が管理対象ユーザー単位としてインストールされていない場合、製品がマシン単位でインストールされていても、関数は ERROR_UNKNOWN_PRODUCT を返します。

メモ

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

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

各言語での呼び出し定義

// msi.dll  (Unicode / -W)
#include <windows.h>

DWORD MsiSourceListClearAllW(
    LPCWSTR szProduct,
    LPCWSTR szUserName,   // optional
    DWORD dwReserved   // optional
);
[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiSourceListClearAllW(
    [MarshalAs(UnmanagedType.LPWStr)] string szProduct,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string szUserName,   // LPCWSTR optional
    uint dwReserved   // DWORD optional
);
<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiSourceListClearAllW(
    <MarshalAs(UnmanagedType.LPWStr)> szProduct As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> szUserName As String,   ' LPCWSTR optional
    dwReserved As UInteger   ' DWORD optional
) As UInteger
End Function
' szProduct : LPCWSTR
' szUserName : LPCWSTR optional
' dwReserved : DWORD optional
Declare PtrSafe Function MsiSourceListClearAllW Lib "msi" ( _
    ByVal szProduct As LongPtr, _
    ByVal szUserName As LongPtr, _
    ByVal dwReserved As Long) 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

MsiSourceListClearAllW = ctypes.windll.msi.MsiSourceListClearAllW
MsiSourceListClearAllW.restype = wintypes.DWORD
MsiSourceListClearAllW.argtypes = [
    wintypes.LPCWSTR,  # szProduct : LPCWSTR
    wintypes.LPCWSTR,  # szUserName : LPCWSTR optional
    wintypes.DWORD,  # dwReserved : DWORD optional
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiSourceListClearAllW = Fiddle::Function.new(
  lib['MsiSourceListClearAllW'],
  [
    Fiddle::TYPE_VOIDP,  # szProduct : LPCWSTR
    Fiddle::TYPE_VOIDP,  # szUserName : LPCWSTR optional
    -Fiddle::TYPE_INT,  # dwReserved : DWORD optional
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "msi")]
extern "system" {
    fn MsiSourceListClearAllW(
        szProduct: *const u16,  // LPCWSTR
        szUserName: *const u16,  // LPCWSTR optional
        dwReserved: u32  // DWORD optional
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Unicode)]
public static extern uint MsiSourceListClearAllW([MarshalAs(UnmanagedType.LPWStr)] string szProduct, [MarshalAs(UnmanagedType.LPWStr)] string szUserName, uint dwReserved);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiSourceListClearAllW' -Namespace Win32 -PassThru
# $api::MsiSourceListClearAllW(szProduct, szUserName, dwReserved)
#uselib "msi.dll"
#func global MsiSourceListClearAllW "MsiSourceListClearAllW" wptr, wptr, wptr
; MsiSourceListClearAllW szProduct, szUserName, dwReserved   ; 戻り値は stat
; szProduct : LPCWSTR -> "wptr"
; szUserName : LPCWSTR optional -> "wptr"
; dwReserved : DWORD optional -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "msi.dll"
#cfunc global MsiSourceListClearAllW "MsiSourceListClearAllW" wstr, wstr, int
; res = MsiSourceListClearAllW(szProduct, szUserName, dwReserved)
; szProduct : LPCWSTR -> "wstr"
; szUserName : LPCWSTR optional -> "wstr"
; dwReserved : DWORD optional -> "int"
; DWORD MsiSourceListClearAllW(LPCWSTR szProduct, LPCWSTR szUserName, DWORD dwReserved)
#uselib "msi.dll"
#cfunc global MsiSourceListClearAllW "MsiSourceListClearAllW" wstr, wstr, int
; res = MsiSourceListClearAllW(szProduct, szUserName, dwReserved)
; szProduct : LPCWSTR -> "wstr"
; szUserName : LPCWSTR optional -> "wstr"
; dwReserved : DWORD optional -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiSourceListClearAllW = msi.NewProc("MsiSourceListClearAllW")
)

// szProduct (LPCWSTR), szUserName (LPCWSTR optional), dwReserved (DWORD optional)
r1, _, err := procMsiSourceListClearAllW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szProduct))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szUserName))),
	uintptr(dwReserved),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function MsiSourceListClearAllW(
  szProduct: PWideChar;   // LPCWSTR
  szUserName: PWideChar;   // LPCWSTR optional
  dwReserved: DWORD   // DWORD optional
): DWORD; stdcall;
  external 'msi.dll' name 'MsiSourceListClearAllW';
result := DllCall("msi\MsiSourceListClearAllW"
    , "WStr", szProduct   ; LPCWSTR
    , "WStr", szUserName   ; LPCWSTR optional
    , "UInt", dwReserved   ; DWORD optional
    , "UInt")   ; return: DWORD
●MsiSourceListClearAllW(szProduct, szUserName, dwReserved) = DLL("msi.dll", "dword MsiSourceListClearAllW(char*, char*, dword)")
# 呼び出し: MsiSourceListClearAllW(szProduct, szUserName, dwReserved)
# szProduct : LPCWSTR -> "char*"
# szUserName : LPCWSTR optional -> "char*"
# dwReserved : DWORD optional -> "dword"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "msi" fn MsiSourceListClearAllW(
    szProduct: [*c]const u16, // LPCWSTR
    szUserName: [*c]const u16, // LPCWSTR optional
    dwReserved: u32 // DWORD optional
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc MsiSourceListClearAllW(
    szProduct: WideCString,  # LPCWSTR
    szUserName: WideCString,  # LPCWSTR optional
    dwReserved: uint32  # DWORD optional
): uint32 {.importc: "MsiSourceListClearAllW", stdcall, dynlib: "msi.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "msi");
extern(Windows)
uint MsiSourceListClearAllW(
    const(wchar)* szProduct,   // LPCWSTR
    const(wchar)* szUserName,   // LPCWSTR optional
    uint dwReserved   // DWORD optional
);
ccall((:MsiSourceListClearAllW, "msi.dll"), stdcall, UInt32,
      (Cwstring, Cwstring, UInt32),
      szProduct, szUserName, dwReserved)
# szProduct : LPCWSTR -> Cwstring
# szUserName : LPCWSTR optional -> Cwstring
# dwReserved : DWORD optional -> UInt32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiSourceListClearAllW(
    const uint16_t* szProduct,
    const uint16_t* szUserName,
    uint32_t dwReserved);
]]
local msi = ffi.load("msi")
-- msi.MsiSourceListClearAllW(szProduct, szUserName, dwReserved)
-- szProduct : LPCWSTR
-- szUserName : LPCWSTR optional
-- dwReserved : DWORD 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 MsiSourceListClearAllW = lib.func('__stdcall', 'MsiSourceListClearAllW', 'uint32_t', ['str16', 'str16', 'uint32_t']);
// MsiSourceListClearAllW(szProduct, szUserName, dwReserved)
// szProduct : LPCWSTR -> 'str16'
// szUserName : LPCWSTR optional -> 'str16'
// dwReserved : DWORD optional -> 'uint32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("msi.dll", {
  MsiSourceListClearAllW: { parameters: ["buffer", "buffer", "u32"], result: "u32" },
});
// lib.symbols.MsiSourceListClearAllW(szProduct, szUserName, dwReserved)
// szProduct : LPCWSTR -> "buffer"
// szUserName : LPCWSTR optional -> "buffer"
// dwReserved : DWORD optional -> "u32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiSourceListClearAllW(
    const uint16_t* szProduct,
    const uint16_t* szUserName,
    uint32_t dwReserved);
C, "msi.dll");
// $ffi->MsiSourceListClearAllW(szProduct, szUserName, dwReserved);
// szProduct : LPCWSTR
// szUserName : LPCWSTR optional
// dwReserved : DWORD 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 MsiSourceListClearAllW(
        WString szProduct,   // LPCWSTR
        WString szUserName,   // LPCWSTR optional
        int dwReserved   // DWORD optional
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("msi")]
lib Libmsi
  fun MsiSourceListClearAllW = MsiSourceListClearAllW(
    szProduct : UInt16*,   # LPCWSTR
    szUserName : UInt16*,   # LPCWSTR optional
    dwReserved : UInt32   # DWORD optional
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef MsiSourceListClearAllWNative = Uint32 Function(Pointer<Utf16>, Pointer<Utf16>, Uint32);
typedef MsiSourceListClearAllWDart = int Function(Pointer<Utf16>, Pointer<Utf16>, int);
final MsiSourceListClearAllW = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiSourceListClearAllWNative, MsiSourceListClearAllWDart>('MsiSourceListClearAllW');
// szProduct : LPCWSTR -> Pointer<Utf16>
// szUserName : LPCWSTR optional -> Pointer<Utf16>
// dwReserved : DWORD optional -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiSourceListClearAllW(
  szProduct: PWideChar;   // LPCWSTR
  szUserName: PWideChar;   // LPCWSTR optional
  dwReserved: DWORD   // DWORD optional
): DWORD; stdcall;
  external 'msi.dll' name 'MsiSourceListClearAllW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiSourceListClearAllW"
  c_MsiSourceListClearAllW :: CWString -> CWString -> Word32 -> IO Word32
-- szProduct : LPCWSTR -> CWString
-- szUserName : LPCWSTR optional -> CWString
-- dwReserved : DWORD optional -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msisourcelistclearallw =
  foreign "MsiSourceListClearAllW"
    ((ptr uint16_t) @-> (ptr uint16_t) @-> uint32_t @-> returning uint32_t)
(* szProduct : LPCWSTR -> (ptr uint16_t) *)
(* szUserName : LPCWSTR optional -> (ptr uint16_t) *)
(* dwReserved : DWORD optional -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)

(cffi:defcfun ("MsiSourceListClearAllW" msi-source-list-clear-all-w :convention :stdcall) :uint32
  (sz-product (:string :encoding :utf-16le))   ; LPCWSTR
  (sz-user-name (:string :encoding :utf-16le))   ; LPCWSTR optional
  (dw-reserved :uint32))   ; DWORD optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiSourceListClearAllW = Win32::API::More->new('msi',
    'DWORD MsiSourceListClearAllW(LPCWSTR szProduct, LPCWSTR szUserName, DWORD dwReserved)');
# my $ret = $MsiSourceListClearAllW->Call($szProduct, $szUserName, $dwReserved);
# szProduct : LPCWSTR -> LPCWSTR
# szUserName : LPCWSTR optional -> LPCWSTR
# dwReserved : DWORD optional -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い
類似 API
公式の関連項目