MsiSourceListClearMediaDisk function

The MsiSourceListClearMediaDisk function provides the ability to remove an existing registered disk under the media source for a product or patch in a specific context.

Syntax


UINT MsiSourceListClearMediaDisk(
  _In_     LPCTSTR           szProductCodeOrPatchCode,
  _In_opt_ LPCTSTR           szUserSid,
  _In_     MSIINSTALLCONTEXT dwContext,
  _In_     DWORD             dwOptions,
  _In_     DWORD             dwDiskID
);

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.

Type of SIDMeaning
NULL

NULL denotes the currently logged on user. When referencing the current user account, szUserSID can be NULL and dwContext can be MSIINSTALLCONTEXT_USERMANAGED or MSIINSTALLCONTEXT_USERUNMANAGED.

User SID

Specifies enumeration for a particular user in the system. An example of user SID is "S-1-3-64-2415071341-1358098788-3127455600-2561".

 

Note  The special SID string s-1-5-18 (system) cannot be used to enumerate products or patches installed as per-machine. Setting the SID value to s-1-5-18 returns ERROR_INVALID_PARAMETER. When dwContext is set to MSIINSTALLCONTEXT_MACHINE only, szUserSid must be NULL.
 
Note  The special SID string s-1-1-0 (everyone) should not be used. Setting the SID value to s-1-1-0 fails and returns ERROR_INVALID_PARAM.
 
dwContext [in]

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

Type of contextMeaning
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 specifies the meaning of szProductCodeOrPatchCode.

FlagMeaning
MSICODE_PRODUCT

szProductCodeOrPatchCode is a product code GUID.

MSICODE_PATCH

szProductCodeOrPatchCode is a patch code GUID.

 

dwDiskID [in]

This parameter provides the ID of the disk being removed.

Return value

The MsiSourceListClearMediaDisk function returns the following values.

ValueMeaning
ERROR_ACCESS_DENIED

The user does not have the ability to read the specified media source or the specified product or patch. This does not indicate whether a media source, product or patch was found.

ERROR_BAD_CONFIGURATION

The configuration data is corrupt.

ERROR_INSTALL_SERVICE_FAILURE

The Windows Installer service could not be accessed.

ERROR_INVALID_PARAMETER

An invalid parameter was passed to the function.

ERROR_SUCCESS

The value was successfully removed or not found.

ERROR_UNKNOWN_PATCH

The patch was not found.

ERROR_UNKNOWN_PRODUCT

The product was not found.

ERROR_FUNCTION_FAILED

Unexpected internal failure.

 

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 the DisableBrowse, AllowLockdownBrowse, and AlwaysInstallElevated policies.

Requirements

Version

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 3.0 or later 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.

Header

Msi.h

Library

Msi.lib

DLL

Msi.dll

Unicode and ANSI names

MsiSourceListClearMediaDiskW (Unicode) and MsiSourceListClearMediaDiskA (ANSI)

See also

ProductCode
Not Supported in Windows Installer 2.0 and earlier

 

 

Show: