The MsiDeterminePatchSequence function takes a set of patch files, XML files, and XML blobs and determines the best sequence of application for the patches to a specified installed product. This function accounts for patches that have already been applied to the product and accounts for obsolete and superseded patches.

Syntax

C++UINT MsiDeterminePatchSequence(
  __in      LPCTSTR szProductCode,
  __in_opt  LPCTSTR szUserSid,
  __in      MSIINSTALLCONTEXT dwContext,
  __in      DWORD cPatchInfo,
  __in      PMSIPATCHSEQUENCEINFO pPatchInfo
);

Parameters

szProductCode [in]

The product that is the target for the set of patches. The value must be the ProductCode GUID for the product.

szUserSid [in, optional]

Null-terminated string that specifies a security identifier (SID) of a user. This parameter restricts the context of enumeration for this user account. This parameter cannot be the special SID strings s-1-1-0 (everyone) or s-1-5-18 (local system). For the machine context dwContext is set to MSIINSTALLCONTEXT_MACHINE and szUserSid must be null. For the current user context szUserSid can be null and dwContext can be set to MSIINSTALLCONTEXT_USERMANAGED or MSIINSTALLCONTEXT_USERUNMANAGED.

dwContext [in]

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.

Type of context	Meaning
MSIINSTALLCONTEXT_USERMANAGED	Patches are considered for all per-user-managed installations of the product for the user specified by szUserSid. A null szUserSid with this context means the current user.
MSIINSTALLCONTEXT_USERUNMANAGED	Patches are considered for all per-user-unmanaged installations for the user specified by szUserSid. A null szUserSid with this context means the current user.
MSIINSTALLCONTEXT_MACHINE	Patches are considered for the per-machine installation. When dwContext is set to MSIINSTALLCONTEXT_MACHINE the szUserSid parameter must be null.

 

cPatchInfo [in]

The number of patches in the array.

pPatchInfo [in]

Pointer to an array of MSIPATCHSEQUENCEINFO structures.

Return Value

The MsiDeterminePatchSequence function returns the following values.

Remarks

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

Users that do not have administrator privileges can call this function only in their own or machine context. Users that are administrators can call it for other users.

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 MsiDeterminePatchSequence 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

MsiDetermineApplicablePatches

MSIPATCHSEQUENCEINFO

Send comments about this topic to Microsoft

Build date: 8/13/2009