MsiApplyMultiplePatchesA function (msi.h)
The MsiApplyMultiplePatches function applies one or more patches to products eligible to receive the patches. The MsiApplyMultiplePatches function sets the PATCH property with a list of patches delimited by semicolons and invokes the patching of the target products. Other properties can be set using a properties list.
Syntax
UINT MsiApplyMultiplePatchesA(
[in] LPCSTR szPatchPackages,
[in, optional] LPCSTR szProductCode,
[in, optional] LPCSTR szPropertiesList
);
Parameters
[in] szPatchPackages
A semicolon-delimited list of the paths to patch files as a single string. For example: ""c:\sus\download\cache\Office\sp1.msp; c:\sus\download\cache\Office\QFE1.msp; c:\sus\download\cache\Office\QFEn.msp" "
[in, optional] szProductCode
This parameter is the ProductCode GUID of the product to be patched. The user or application calling MsiApplyMultiplePatches must have privileges to apply patches. When this parameter is NULL, the patches are applied to all eligible products. When this parameter is non-NULL, the patches are applied only to the specified product.
[in, optional] szPropertiesList
A null-terminated string that specifies command–line property settings used during the patching of products. If there are no command–line property settings, pass in a NULL pointer. An empty string is an invalid parameter. These properties are shared by all target products. For more information, see
About Properties and
Setting Public Property Values on the Command Line.
Return value
The MsiApplyMultiplePatches function returns the following values.
| Value | Meaning |
|---|---|
|
Some arguments passed in are incorrect or contradicting. |
|
The function completed and all products are successfully patched. ERROR_SUCCESS is returned only if all the products eligible for the patches are patched successfully. If none of the new patches are applicable, MsiApplyMultiplePatches returns ERROR_SUCCESS and product state remains unchanged. |
|
The restart initiated by the last transaction terminated this call to MsiApplyMultiplePatches. All the target products may not have been patched. |
|
The restart required by the last transaction terminated this call to MsiApplyMultiplePatches. All target products may not have been patched. |
|
One of the patch packages provide could not be opened. |
|
One of the patch packages provide is not a valid one. |
|
One of the patch packages is unsupported. |
|
Implies possible partial completion or that one or more transactions failed. |
Remarks
Note
The msi.h header defines MsiApplyMultiplePatches 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 |
See also
Multiple-Package Installations