MsiSourceListAddMediaDiskA function (msi.h)

The MsiSourceListAddMediaDisk function adds or updates a disk of the media source of a registered product or patch. If the disk specified already exists, it is updated with the new values. If the disk specified does not exist, a new disk entry is created with the new values.

Syntax

UINT MsiSourceListAddMediaDiskA(
  [in]           LPCSTR            szProductCodeOrPatchCode,
  [in, optional] LPCSTR            szUserSid,
  [in]           MSIINSTALLCONTEXT dwContext,
  [in]           DWORD             dwOptions,
  [in]           DWORD             dwDiskId,
  [in]           LPCSTR            szVolumeLabel,
  [in, optional] LPCSTR            szDiskPrompt
);

Parameters

[in] szProductCodeOrPatchCode

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.

[in, optional] szUserSid

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.

[in] dwContext

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

[in] dwOptions

The dwOptions value specifies the meaning of szProductCodeOrPatchCode.

[in] dwDiskId

This parameter provides the ID of the disk being added or updated.

[in] szVolumeLabel

The szVolumeLabel provides the label of the disk being added or updated. An update overwrites the existing volume label in the registry. To change the disk prompt only, get the existing volume label from the registry and provide it in this call along with the new disk prompt. Passing a NULL or empty string for szVolumeLabel registers an empty string (0 bytes in length) as the volume label.

[in, optional] szDiskPrompt

On entry to MsiSourceListAddMediaDisk, szDiskPrompt provides the disk prompt of the disk being added or updated. An update overwrites the registered disk prompt.
To change the volume label only, get the existing disk prompt that is registered and provide it when calling MsiSourceListAddMediaDisk along with the new volume label. Passing NULL or an empty string registers an empty string (0 bytes in length) as the disk prompt.

Return value

The MsiSourceListAddMediaDisk function returns the following values.

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, AllowLockDownMedia and AlwaysInstallElevated policies.

Requirements

See also

Not Supported in Windows Installer 2.0 and earlier

ProductCode