IDiscMaster::SetActiveDiscMasterFormat method (imapi.h)

Article
02/22/2024

Sets the currently active disc recorder format. The active format specifies both the structure of the staged image file content (audio/data) and the COM interface that must be used to manipulate that staged image.

Syntax

HRESULT SetActiveDiscMasterFormat(
  [in]  REFIID riid,
  [out] void   **ppUnk
);

Parameters

[in] riid

IID of the currently active format.

[out] ppUnk

Pointer to the COM interface for the new disc format.

Return value

S_OK is returned on success, but other success codes may be returned as a result of implementation. The following error codes are commonly returned on operation failure, but do not represent the only possible error values:

Remarks

A successful call to this method clears the contents of the currently staged image. In addition, it may change the list of supported disc recorders. This is because not all recorders support all formats. Changes to the recorder list are announced with IDiscMasterProgressEvents::NotifyPnPActivity. If the currently selected recorder is not a member of the new set of supported devices, then there will no longer be an active recorder (similar to the state after the first call to Open). In this case, the application must select a new active recorder before initiating a burn.

MSDiscMasterObj supports only the following IIDs: IID_IRedbookDiscMaster (IRedbookDiscMaster) and IID_IJolietDiscMaster (IJolietDiscMaster). If there is no format set, the default is Joliet format. It is the responsibility of every application to select a format master through the use of EnumDiscMasterFormats and this method.

Note A call to this method may change the list of available recorders. See the Remarks section of EnumDiscRecorders for more information.

Requirements

Requirement	Value
Minimum supported client	Windows XP [desktop apps only]
Minimum supported server	Windows Server 2003 [desktop apps only]
Target Platform	Windows
Header	imapi.h
Library	Uuid.lib
DLL	Actxprxy.dll

Share via