MsiSourceListClearSourceA 函数 (msi.h)

MsiSourceListClearSource 函数删除指定上下文中产品或修补程序的现有源。 如果删除修补程序的唯一源,并且同一上下文中任何客户端未安装修补程序,也会删除修补程序注册。 指定 MsiSourceListClearSource 删除此产品的当前源或修补程序会强制安装程序下次需要源时搜索源列表。

语法

UINT MsiSourceListClearSourceA(
  [in]           LPCSTR            szProductCodeOrPatchCode,
  [in, optional] LPCSTR            szUserSid,
  [in]           MSIINSTALLCONTEXT dwContext,
  [in]           DWORD             dwOptions,
  [in]           LPCSTR            szSource
);

参数

[in] szProductCodeOrPatchCode

ProductCode 或修补程序 GUID 的产品或修补程序。 使用以 null 结尾的字符串。 如果字符串长度超过 39 个字符,函数将失败并返回 ERROR_INVALID_PARAMETER。 此参数不能 NULL

[in, optional] szUserSid

此参数可以是指定包含产品或修补程序的用户帐户的字符串 SID。 SID 未验证或解析。 不正确的 SID 可以返回 ERROR_UNKNOWN_PRODUCTERROR_UNKNOWN_PATCH。 引用计算机上下文时,szUserSID 必须 NULLdwContext 必须 MSIINSTALLCONTEXT_MACHINE

SID 的类型 意义
NULL
NULL 表示当前登录的用户。 引用当前用户帐户时,szUserSID 可以 NULLdwContext 可以 MSIINSTALLCONTEXT_USERMANAGEDMSIINSTALLCONTEXT_USERUNMANAGED
用户 SID
指定系统中特定用户的枚举。 用户 SID 的示例是“S-1-3-64-2415071341-1358098788-3127455600-2561”。
 
注意 特殊 SID 字符串“S-1-5-18”(系统)不能用于枚举按计算机安装的产品或修补程序。 将 SID 值设置为“S-1-5-18”将返回 ERROR_INVALID_PARAMETER
 
注意 不应使用特殊的 SID 字符串“S-1-1-0”(每个人)。 将 SID 值设置为“S-1-1-0”失败,并返回 ERROR_INVALID_PARAM
 

[in] dwContext

此参数指定产品或修补程序实例的上下文。 此参数可以包含以下值之一。

上下文类型 意义
MSIINSTALLCONTEXT_USERMANAGED
产品或修补程序实例存在于每个用户管理的上下文中。
MSIINSTALLCONTEXT_USERUNMANAGED
产品或修补程序实例存在于每用户非托管上下文中。
MSIINSTALLCONTEXT_MACHINE
产品或修补程序实例存在于每台计算机上下文中。

[in] dwOptions

dwOptions 值确定 szProductCodeOrPatchCode 值的解释以及要清除的源类型。 此参数必须是下列 MSISOURCETYPE_ 常量之一和下列 MSICODE_ 常量之一的组合。

意义
MSISOURCETYPE_NETWORK
源是网络类型。
MSISOURCETYPE_URL
源是 URL 类型。
MSICODE_PRODUCT
szProductCodeOrPatchCode 是一个代码示例。
MSICODE_PATCH
szProductCodeOrPatchCode 是修补程序代码。

[in] szSource

要删除的源。 此参数应仅包含没有文件名的路径。 文件名已注册为“PackageName”,可通过 MsiSourceListSetInfo操作。 此参数是必需的。

返回值

MsiSourceListClearSource 函数返回以下值。

价值 意义
ERROR_ACCESS_DENIED
用户无法删除源。 不指示是否已找到产品或修补程序。
ERROR_BAD_CONFIGURATION
配置数据已损坏。
ERROR_INSTALL_SERVICE_FAILURE
无法访问 Windows Installer 服务
ERROR_INVALID_PARAMETER
将无效参数传递给函数。
ERROR_SUCCESS
已删除或找不到源。
ERROR_UNKNOWN_PATCH
指定的修补程序未知。
ERROR_UNKNOWN_PRODUCT
指定的产品未知。
ERROR_FUNCTION_FAILED
意外的内部故障。

言论

管理员可以修改计算机上下文下或在其自己的每用户上下文(托管或非托管)下存在的产品或修补程序实例的安装。他们可以修改任何用户每用户托管上下文下存在的产品或修补程序实例的安装。 管理员无法修改其他用户安装在该用户的每用户非托管上下文下存在的产品或修补程序实例。

非管理员无法修改其他用户的每个用户上下文(托管或非托管)下存在的产品或修补程序实例的安装。他们可以修改在其自己的每用户非托管上下文下存在的产品或修补程序实例的安装。 仅当启用了产品或修补程序源浏览时,他们才能修改计算机上下文下的产品或修补程序实例的安装或自己的按用户管理的上下文。 用户可以通过设置策略来浏览源。 有关详细信息,请参阅 DisableBrowseAllowLockdownBrowse,以及 AlwaysInstallElevated 策略。

注意

msi.h 标头将 MsiSourceListClearSource 定义为一个别名,该别名根据 UNICODE 预处理器常量的定义自动选择此函数的 ANSI 或 Unicode 版本。 将中性编码别名与不中性编码的代码混合使用可能会导致编译或运行时错误不匹配。 有关详细信息,请参阅函数原型的 约定。

要求

要求 价值
最低支持的客户端 Windows Server 2012、Windows 8、Windows Server 2008 R2 或 Windows 7 上的 Windows Installer 5.0。 Windows Server 2008 或 Windows Vista 上的 Windows Installer 4.0 或 Windows Installer 4.5。 有关 Windows Installer 版本所需的最低 Windows Service Pack 的信息,请参阅 Windows Installer Run-Time 要求。
目标平台 窗户
标头 msi.h
Msi.lib
DLL Msi.dll

另请参阅

AllowLockdownBrowse

AlwaysInstallElevated

DisableBrowse

MsiSourceListSetInfo

Windows Installer 2.0 及更早版本中不支持

ProductCode

源复原能力