MsiGetPatchInfoExA function (msi.h)
The MsiGetPatchInfoEx function queries for information about the application of a patch to a specified instance of a product.
Syntax
UINT MsiGetPatchInfoExA(
[in] LPCSTR szPatchCode,
[in] LPCSTR szProductCode,
[in] LPCSTR szUserSid,
[in] MSIINSTALLCONTEXT dwContext,
[in] LPCSTR szProperty,
[out, optional] LPSTR lpValue,
[in, out] LPDWORD pcchValue
);
Parameters
[in] szPatchCode
A null-terminated string that contains the GUID of the patch. This parameter cannot be NULL.
[in] szProductCode
A null-terminated string that contains the ProductCode GUID of the product instance. This parameter cannot be NULL.
[in] szUserSid
A null-terminated string that specifies the security identifier (SID) under which the instance of the patch being queried exists. Using a NULL value specifies the current user.
[in] dwContext
Restricts the enumeration to a per-user-unmanaged, per-user-managed, or per-machine context. This parameter can be any one of the following values.
[in] szProperty
A null-terminated string that specifies the property value to retrieve. The szProperty parameter can be one of the following:
| Name | Meaning |
|---|---|
|
Gets the cached patch file that the product uses. |
|
Gets the set of patch transforms that the last patch installation applied to the product. This value may not be available for per-user, non-managed applications if the user is not logged on. |
|
Gets the last time this product received service. The value of this property is replaced each time a patch is applied or removed from the product or the /v Command-Line Option is used to repair the product. If the product has received no repairs or patches this property contains the time this product was installed on this computer. |
|
Returns "1" if the patch is marked as possible to uninstall from the product. In this case, the installer can still block the uninstallation if this patch is required by another patch that cannot be uninstalled. |
|
Returns "1" if this patch is currently applied to the product. Returns "2" if this patch is superseded by another patch. Returns "4" if this patch is obsolete. These values correspond to the constants the dwFilter parameter of MsiEnumPatchesEx uses. |
|
Get the registered display name for the patch. For patches that do not include the DisplayName property in the MsiPatchMetadata table, the returned display name is an empty string (""). |
|
Get the registered support information URL for the patch. For patches that do not include the MoreInfoURL property in the MsiPatchMetadata table, the returned support information URL is an empty string (""). |
[out, optional] lpValue
This parameter is a pointer to a buffer that receives the property value. 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 property value, not including the terminating NULL character.
If lpValue 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 lpValue buffer large enough to contain *pcchValue + 1 characters.
If lpValue and pcchValue are both set to NULL, the function returns ERROR_SUCCESS if the value exists, without retrieving the value.
[in, out] pcchValue
When calling the function, this parameter should be a pointer to a variable that specifies the number of TCHAR in the lpValue 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 lpValue is also NULL. Otherwise, the function returns ERROR_INVALID_PARAMETER.
Return value
The MsiGetPatchInfoEx function returns the following values.
| Return code | Description |
|---|---|
|
The function fails trying to access a resource with insufficient privileges. |
|
The configuration data is corrupt. |
|
The function fails and the error is not identified in other error codes. |
|
An invalid parameter is passed to the function. |
|
The value does not fit in the provided buffer. |
|
The patch is enumerated successfully. |
|
The product that szProduct specifies is not installed on the computer. |
|
The property is unrecognized. |
|
The patch is unrecognized. |
Remarks
Windows Installer 2.0: Not supported. This function is available beginning with Windows Installer version 3.0.
A user may query patch data for any product instance that is visible. The administrator group can query patch data for any product instance and any user on the computer. Not all values are guaranteed to be available for per-user, non-managed applications if the user is not logged on.
Note
The msi.h header defines MsiGetPatchInfoEx as an alias that 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 is 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. 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 |