msi.h) (MsiSourceListGetInfoA 函数

  • 项目

MsiSourceListGetInfo 函数检索特定上下文中有关产品或修补程序的源列表的信息。

语法

UINT MsiSourceListGetInfoA(
  [in]                LPCSTR            szProductCodeOrPatchCode,
  [in, optional]      LPCSTR            szUserSid,
  [in]                MSIINSTALLCONTEXT dwContext,
  [in]                DWORD             dwOptions,
  [in]                LPCSTR            szProperty,
  [out, optional]     LPSTR             szValue,
  [in, out, optional] LPDWORD           pcchValue
);

parameters

[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”。
 
注意 特殊 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 的含义。

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

[in] szProperty

以 null 结尾的字符串，指定要检索的属性值。 szProperty 参数可以是以下值之一。

名称 含义
INSTALLPROPERTY_MEDIAPACKAGEPATH
“MediaPackagePath”
 相对于安装介质根目录的路径。
INSTALLPROPERTY_DISKPROMPT
“DiskPrompt”
 提示用户输入安装媒体时使用的提示模板。
INSTALLPROPERTY_LASTUSEDSOURCE
“LastUsedSource”
 产品最近使用的源位置。
INSTALLPROPERTY_LASTUSEDTYPE
“LastUsedType”
 如果上次使用的源是网络位置，则为“n”。 如果上次使用的源是 URL 位置，则为“u”。 如果上次使用的源是媒体，则为“m”。 如果没有上次使用的源，则 (“”) 空字符串。
INSTALLPROPERTY_PACKAGENAME
“PackageName”
 源上的 Windows Installer 程序包或补丁程序包的名称。

[out, optional] szValue

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

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

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

[in, out, optional] pcchValue

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

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

返回值

MsiSourceListGetInfo 函数返回以下值。

值 含义
ERROR_ACCESS_DENIED
 用户无法读取指定的源列表。 这并不指示是否找到了产品或修补程序。
ERROR_BAD_CONFIGURATION
 配置数据已损坏。
ERROR_INVALID_PARAMETER
 将无效参数传递给函数。
ERROR_MORE_DATA
 提供的缓冲区不足以包含请求的数据。
ERROR_SUCCESS
 已成功检索属性。
ERROR_UNKNOWN_PATCH
 找不到修补程序。
ERROR_UNKNOWN_PRODUCT
 找不到该产品。
ERROR_UNKNOWN_PROPERTY
 找不到源属性。
ERROR_FUNCTION_FAILED
 意外的内部故障。

注解

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

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

注意

msi.h 标头将 MsiSourceListGetInfo 定义为别名，该别名根据 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

另请参阅

MsiSourceListSetInfo

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

ProductCode