MsiSourceListGetInfoA function (msi.h)
The MsiSourceListGetInfo function retrieves information about the source list for a product or patch in a specific context.
Syntax
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
The ProductCode or patch GUID of the product or patch. Use a null-terminated string. If the string is longer than 39 characters, the function fails and returns ERROR_INVALID_PARAMETER. This parameter cannot be NULL.
[in, optional] szUserSid
This parameter can be a string security identifier (SID) that specifies the user account that contains the product or patch. The SID is not validated or resolved. An incorrect SID can return ERROR_UNKNOWN_PRODUCT or ERROR_UNKNOWN_PATCH. When referencing a machine context, szUserSID must be NULL and dwContext must be MSIINSTALLCONTEXT_MACHINE.
[in] dwContext
This parameter specifies the context of the product or patch instance. This parameter can contain one of the following values.
[in] dwOptions
The dwOptions value specifies the meaning of szProductCodeOrPatchCode.
| Flag | Meaning |
|---|---|
|
szProductCodeOrPatchCode is a product code GUID. |
|
szProductCodeOrPatchCode is a patch code GUID. |
[in] szProperty
A null-terminated string that specifies the property value to retrieve. The szProperty parameter can be one of the following values.
[out, optional] szValue
An output buffer that receives the information. This buffer should be large enough to contain the information. If the buffer is too small, the function returns ERROR_MORE_DATA and sets *pcchValue to the number of TCHAR in the value, not including the terminating NULL character.
If the szValue is set to NULL and pcchValue is set to a valid pointer, the function returns ERROR_SUCCESS and sets *pcchValue to the number of TCHAR in the value, not including the terminating NULL character. The function can then be called again to retrieve the value, with szValue buffer large enough to contain *pcchValue + 1 characters.
If szValue and pcchValue are both set to NULL, the function returns ERROR_SUCCESS if the value exists, without retrieving the value.
[in, out, optional] pcchValue
A pointer to a variable that specifies the number of TCHAR in the szValue buffer. When the function returns, this parameter is set to the size of the requested value whether or not the function copies the value into the specified buffer. The size is returned as the number of TCHAR in the requested value, not including the terminating null character.
This parameter can be set to NULL only if szValue is also NULL, otherwise the function returns ERROR_INVALID_PARAMETER.
Return value
The MsiSourceListGetInfo function returns the following values.
| Value | Meaning |
|---|---|
|
The user does not have the ability to read the specified source list. This does not indicate whether a product or patch is found. |
|
The configuration data is corrupt. |
|
An invalid parameter is passed to the function. |
|
The provided buffer is not sufficient to contain the requested data. |
|
The property is retrieved successfully. |
|
The patch is not found. |
|
The product is not found. |
|
The source property is not found. |
|
An unexpected internal failure. |
Remarks
Administrators can modify the installation of a product or patch instance that exists under the machine context or under their own per-user context (managed or unmanaged.) They can modify the installation of a product or patch instance that exists under any user's per-user-managed context. Administrators cannot modify another user's installation of a product or patch instance that exists under that other user's per-user-unmanaged context.
Non-administrators cannot modify the installation of a product or patch instance that exists under another user's per-user context (managed or unmanaged.) They can modify the installation of a product or patch instance that exists under their own per-user-unmanaged context. They can modify the installation of a product or patch instance under the machine context or their own per-user-managed context only if they are enabled to browse for a product or patch source. Users can be enabled to browse for sources by setting policy. For more information, see DisableBrowse, AllowLockdownBrowse, and AlwaysInstallElevated policies.
Note
The msi.h header defines MsiSourceListGetInfo as an alias which automatically selects the ANSI or Unicode version of this function based on the definition of the UNICODE preprocessor constant. Mixing usage of the encoding-neutral alias with code that not encoding-neutral can lead to mismatches that result in compilation or runtime errors. For more information, see Conventions for Function Prototypes.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows Installer 5.0 on Windows Server 2012, Windows 8, Windows Server 2008 R2 or Windows 7. Windows Installer 4.0 or Windows Installer 4.5 on Windows Server 2008 or Windows Vista. Windows Installer 3.0 or later on Windows Server 2003 or Windows XP. See the Windows Installer Run-Time Requirements for information about the minimum Windows service pack that is required by a Windows Installer version. |
| Target Platform | Windows |
| Header | msi.h |
| Library | Msi.lib |
| DLL | Msi.dll |