The MsiSourceListClearAllEx function removes all the existing sources of a given source type for the specified product or patch instance. The patch registration is also removed if the sole source of the patch gets removed and if the patch is not installed as a new patch by any client in the same context. Specifying that MsiSourceListClearAllEx remove the current source for this product or patch forces the installer to search the source list for a source the next time a source is required.

Syntax

C++UINT MsiSourceListClearAllEx(
  __in      LPCTSTR szProductCodeOrPatchCode,
  __in_opt  LPCTSTR szUserSid,
  __in      MSIINSTALLCONTEXT dwContext,
  __in      DWORD dwOptions
);

Parameters

szProductCodeOrPatchCode [in]

The ProductCode or patch GUID of the product or patch. Use a null-terminated string. If the string is longer than 39 characters, the function fails and returns ERROR_INVALID_PARAMETER. This parameter cannot be NULL.

szUserSid [in, optional]

This parameter can be a string SID that specifies the user account that contains the product or patch. The SID is not validated or resolved. An incorrect SID can return ERROR_UNKNOWN_PRODUCT or ERROR_UNKNOWN_PATCH. When referencing a machine context, szUserSID must be NULL and dwContext must be MSIINSTALLCONTEXT_MACHINE. Using the machine SID ("S-1-5-18") returns ERROR_INVALID PARAMETER. When referencing the current user account, szUserSID can be NULL and dwContext can be MSIINSTALLCONTEXT_USERMANAGED or MSIINSTALLCONTEXT_USERUNMANAGED.

dwContext [in]

This parameter specifies the context of the product or patch instance. This parameter can contain one of the following values.

Type of context	Meaning
MSIINSTALLCONTEXT_USERMANAGED	The product or patch instance exists in the per-user-managed context.
MSIINSTALLCONTEXT_USERUNMANAGED	The product or patch instance exists in the per-user-unmanaged context.
MSIINSTALLCONTEXT_MACHINE	The product or patch instance exists in the per-machine context.

 

dwOptions [in]

The dwOptions value determines the interpretation of the szProductCodeOrPatchCode value and the type of sources to clear. This parameter must be a combination of one of the following MSISOURCETYPE_* constants and one of the following MSICODE_* constants.

Flag	Meaning
MSISOURCETYPE_MEDIA	The source is media.
MSISOURCETYPE_NETWORK	The source is a network type.
MSISOURCETYPE_URL	The source is a URL type.
MSICODE_PATCH	szProductCodeOrPatchCode is a patch code.
MSICODE_PRODUCT	szProductCodeOrPatchCode is a product code.

 

Return Value

Remarks

Administrators can modify the installation of a product or patch instance that exists under the machine context or under their own per-user context (managed or unmanaged.) They can modify the installation of a product or patch instance that exists under any user's per-user-managed context. Administrators cannot modify another user's installation of a product or patch instance that exists under that other user's per-user-unmanaged context.

Non-administrators cannot modify the installation of a product or patch instance that exists under another user's per-user context (managed or unmanaged.) They can modify the installation of a product or patch instance that exists under their own per-user-unmanaged context. They can modify the installation of a product or patch instance under the machine context or their own per-user-managed context only if they are enabled to browse for a product or patch source. Users can be enabled to browse for sources by setting policy, for more information, see DisableBrowse, AllowLockdownBrowse, and AlwaysInstallElevated policies.

Windows Installer 2.0:  Not supported. The MsiSourceListClearAllEx function is available beginning with Windows Installer 3.0.

Requirements

See Also

AllowLockdownBrowse

AlwaysInstallElevated

DisableBrowse

ProductCode

Send comments about this topic to Microsoft

Build date: 8/13/2009