MsiGetPatchInfoA function (msi.h)
The MsiGetPatchInfo function returns information about a patch.
Syntax
UINT MsiGetPatchInfoA(
[in] LPCSTR szPatch,
[in] LPCSTR szAttribute,
[out] LPSTR lpValueBuf,
[in, out] LPDWORD pcchValueBuf
);
Parameters
[in] szPatch
Specifies the patch code for the patch package.
[in] szAttribute
Specifies the attribute to be retrieved.
| Attribute | Meaning |
|---|---|
|
Local cached package. |
[out] lpValueBuf
Pointer to a buffer that receives the property value. This parameter can be null.
[in, out] pcchValueBuf
Pointer to a variable that specifies the size, in characters, of the buffer pointed to by the lpValueBuf parameter. On input, this is the full size of the buffer, including a space for a terminating null character. If the buffer passed in is too small, the count returned does not include the terminating null character.
If lpValueBuf is null, pcchValueBuf can be null.
Return value
The MsiGetPatchInfo function returns the following values.
| Value | Meaning |
|---|---|
|
The configuration data is corrupt. |
|
An invalid parameter was passed to the function. |
|
A buffer is too small to hold the requested data. |
|
The function completed successfully. |
|
The patch package is not installed. |
|
The property is unrecognized. |
Remarks
When the MsiGetPatchInfo function returns, the pcchValueBuf parameter contains the length of the class string stored in the buffer. The count returned does not include the terminating null character.
If the buffer is too small to hold the requested data, MsiGetPatchInfo returns ERROR_MORE_DATA, and pcchValueBuf contains the number of characters copied to lpValueBuf, without counting the null character.
Note
The msi.h header defines MsiGetPatchInfo 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 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 |