msiSourceListEnumMediaDisksA 函数 (msi.h)

  • 项目

MsiSourceListEnumMediaDisks 函数枚举为修补程序或产品的媒体源注册的磁盘列表。

语法

UINT MsiSourceListEnumMediaDisksA(
  [in]                LPCSTR            szProductCodeOrPatchCode,
  [in, optional]      LPCSTR            szUserSid,
  [in]                MSIINSTALLCONTEXT dwContext,
  [in]                DWORD             dwOptions,
  [in]                DWORD             dwIndex,
  [out, optional]     LPDWORD           pdwDiskId,
  [out, optional]     LPSTR             szVolumeLabel,
  [in, out, optional] LPDWORD           pcchVolumeLabel,
  [out, optional]     LPSTR             szDiskPrompt,
  [in, out, optional] LPDWORD           pcchDiskPrompt
);

参数

[in] szProductCodeOrPatchCode

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

[in, optional] szUserSid

一个字符串 SID，指定包含产品或修补程序的用户帐户。 SID 未验证或解析。 错误的 SID 可能会返回ERROR_UNKNOWN_PRODUCT或ERROR_UNKNOWN_PATCH。 引用计算机上下文时，szUserSID 必须为 NULL，dwContext 必须MSIINSTALLCONTEXT_MACHINE。

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

[in] dwContext

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

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

[in] dwOptions

指定 szProductCodeOrPatchCode 的含义的 dwOptions 值。

标志 含义
MSICODE_PRODUCT
 szProductCodeOrPatchCode 是一个产品代码 GUID。
MSICODE_PATCH
 szProductCodeOrPatchCode 是修补程序代码 GUID。

[in] dwIndex

要检索的源的索引。 首次调用 MsiSourceListEnumMediaDisks 函数时，此参数必须为 0 (零) ，然后在后续调用中递增，直到函数返回ERROR_NO_MORE_ITEMS。

[out, optional] pdwDiskId

在 MsiSourceListEnumMediaDisks 条目中，此参数提供指向 DWORD 的指针，用于接收要枚举的磁盘的 ID。 此参数是可选的。

[out, optional] szVolumeLabel

接收要枚举的磁盘的卷标签的输出缓冲区。 此缓冲区应足够大，可以包含信息。 如果缓冲区太小，该函数将返回ERROR_MORE_DATA并将 *pcchVolumeLabel 设置为值中的 TCHAR 数，不包括终止 NULL 字符。

如果 szVolumeLabel 和 pcchVolumeLabel 都设置为 NULL，则该函数将返回ERROR_SUCCESS（如果该值存在），而不检索该值。

[in, out, optional] pcchVolumeLabel

指向变量的指针，该变量指定 szVolumeLabel 缓冲区中的 TCHAR 数。 当函数返回时，此参数是接收值中的 TCHAR 数，不包括终止 null 字符。

仅当 szVolumeLabel 也为 NULL 时，此参数才能设置为 NULL，否则函数返回ERROR_INVALID_PARAMETER。

[out, optional] szDiskPrompt

接收所枚举磁盘的磁盘提示的输出缓冲区。 此缓冲区应足够大，可以包含信息。 如果缓冲区太小，该函数将返回ERROR_MORE_DATA并将 *pcchDiskPrompt 设置为值中的 TCHAR 数，不包括终止 NULL 字符。

如果 szDiskPrompt 设置为 NULL ， 并将 pcchDiskPrompt 设置为有效指针，则该函数将返回ERROR_SUCCESS并将 *pcchDiskPrompt 设置为值中的 TCHAR 数，不包括终止 NULL 字符。 然后，可以再次调用该函数来检索值，其中 szDiskPrompt 缓冲区足够大，可以包含 *pcchDiskPrompt + 1 个字符。

如果 szDiskPrompt 和 pcchDiskPrompt 都设置为 NULL，则该函数返回ERROR_SUCCESS值（如果存在），而不检索该值。

[in, out, optional] pcchDiskPrompt

指向变量的指针，该变量指定 szDiskPrompt 缓冲区中的 TCHAR 数。 当函数返回时，无论函数是否将值复制到指定的缓冲区中，此参数都设置为请求的值的大小。 大小作为请求值中的 TCHAR 数返回，不包括终止 null 字符。

仅当 szDiskPrompt 也为 NULL 时，此参数才能设置为 NULL，否则函数返回ERROR_INVALID_PARAMETER。

返回值

MsiSourceListEnumMediaDisks 函数返回以下值。

值 含义
ERROR_ACCESS_DENIED
 用户无法读取指定的媒体源或指定的产品或修补程序。 这并不指示是否找到媒体源、产品或修补程序。
ERROR_BAD_CONFIGURATION
 配置数据已损坏。
ERROR_INVALID_PARAMETER
 将无效参数传递给函数。
ERROR_NO_MORE_ITEMS
 没有为此产品或修补程序注册更多磁盘。
ERROR_SUCCESS
 已成功枚举值。
ERROR_UNKNOWN_PATCH
 找不到修补程序。
ERROR_UNKNOWN_PRODUCT
 找不到该产品。
ERROR_MORE_DATA
 提供的缓冲区太小，无法包含请求的信息。
ERROR_FUNCTION_FAILED
 意外的内部故障。

注解

对 MsiSourceListEnumMediaDisks 进行多次调用以枚举单个产品实例的所有源时，必须从同一线程进行每个调用。

管理员可以为自己、每计算机安装以及任何用户的每用户托管安装枚举每用户非托管和托管安装。 管理员无法枚举其他用户的每用户非托管安装。 非管理员只能枚举自己的每用户非托管安装和托管安装以及每计算机安装。

注意

msi.h 标头将 MsiSourceListEnumMediaDisks 定义为别名，该别名根据 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 Server 2003 或 Windows XP 上的 Windows Installer 3.0 或更高版本。 若要了解 Windows Installer 版本所需的最低 Windows Service Pack，请参阅 Windows Installer 运行时要求。
目标平台 Windows
标头 msi.h
Library Msi.lib
DLL Msi.dll

另请参阅

安装上下文

在 Windows Installer 2.0 及更低版本中不受支持

ProductCode