The MsiDetermineApplicablePatches function takes a set of patch files, XML files, and XML blobs and determines which patches apply to a specified Windows Installer package and in what sequence. The function can account for superseded or obsolete patches. This function does not account for products or patches that are installed on the system that are not specified in the set.

Syntax

C++UINT MsiDetermineApplicablePatches(
  __in  LPCTSTR szProductPackagePath,
  __in  DWORD cPatchInfo,
  __in  PMSIPATCHSEQUENCEINFO pPatchInfo
);

Parameters

szProductPackagePath [in]

Full path to an .msi file. The function determines the patches that are applicable to this package and in what sequence.

cPatchInfo [in]

Number of patches in the array. Must be greater than zero.

pPatchInfo [in]

Pointer to an array of MSIPATCHSEQUENCEINFO structures.

Return Value

The MsiDetermineApplicablePatches function returns the following values.

Remarks

Windows Installer 2.0:  Not supported. This function is available beginning with Windows Installer version 3.0.

If this function is called from a custom action it fails and returns ERROR_CALL_NOT_IMPLEMENTED. The function requires MSXML version 3.0 to process XML and returns ERROR_CALL_NOT_IMPLEMENTED if MSXML 3.0 is not installed.

The MsiDetermineApplicablePatches function sets the uStatus and dwOrder members of each MSIPATCHSEQUENCEINFO structure pointed to by pPatchInfo. Each structure contains information about a particular patch.

If the function succeeds, the MSIPATCHSEQUENCEINFO structure of every patch that can be applied to the product returns with a uStatus of ERROR_SUCCESS and a dwOrder greater than or equal to zero. The values of dwOrder greater than or equal to zero indicate the best application sequence for the patches starting with zero.

If the function succeeds, patches excluded from the best patching sequence return a MSIPATCHSEQUENCEINFO structure with a dwOrder equal to -1. In these cases, a uStatus field of ERROR_SUCCESS indicates a patch that is obsolete or superseded for the product. A uStatus field of ERROR_PATCH_TARGET_NOT_FOUND indicates a patch that is inapplicable to the product.

If the function fails, the MSIPATCHSEQUENCEINFO structure for every patch returns a dwOrder equal to -1. In this case, the uStatus fields can contain errors with more information about individual patches. For example, ERROR_PATCH_NO_SEQUENCE is returned for patches that have circular sequencing information.

Requirements

See Also

ProductCode

MsiDeterminePatchSequence

Send comments about this topic to Microsoft

Build date: 8/13/2009