IWMReaderPlaylistBurn::InitPlaylistBurn method (wmsdkidl.h)

[The feature associated with this page, Windows Media Format 11 SDK, is a legacy feature. It has been superseded by Source Reader and Sink Writer. Source Reader and Sink Writer have been optimized for Windows 10 and Windows 11. Microsoft strongly recommends that new code use Source Reader and Sink Writer instead of Windows Media Format 11 SDK, when possible. Microsoft suggests that existing code that uses the legacy APIs be rewritten to use the new APIs if possible.]

The InitPlaylistBurn method initiates the playlist burning process, by checking the files in the playlist to ensure that they are licensed for copying as part of a playlist.

Syntax

HRESULT InitPlaylistBurn(
  [in] DWORD                   cFiles,
  [in] LPCWSTR_WMSDK_TYPE_SAFE *ppwszFilenames,
  [in] IWMStatusCallback       *pCallback,
  [in] void                    *pvContext
);

Parameters

[in] cFiles

Number of files in the playlist. This is also the number of members in the array of file names referenced by pwszFilenames.

[in] ppwszFilenames

Address of an array of WCHAR strings. Each string contains the name of a file in the playlist. You must maintain the file order exactly as it exists in the playlist.

[in] pCallback

Address of the IWMStatusCallback implementation that will receive the WMT_INIT_PLAYLIST_BURN status message.

[in] pvContext

Generic pointer, for use by the application. This is passed to the application in calls to the IWMStatusCallback::OnStatus callback. You can use this parameter to differentiate between messages from different objects when sharing a single status callback.

Return value

The method returns an HRESULT. Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK
The method succeeded.

Remarks

This method executes asynchronously. When it is finished, a WMT_INIT_PLAYLIST_BURN message is sent to the OnStatus method of the IWMStatusCallback interface identified by the pCallback parameter.

The files are checked to determine whether they are DRM-protected. If a file is protected, its license is checked to verify that the license allows copying to CD as part of a playlist.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only],Windows Media Format 9.5 SDK
Minimum supported server Windows Server 2003 [desktop apps only]
Target Platform Windows
Header wmsdkidl.h (include Wmsdk.h)
Library Wmvcore.lib; WMStubDRM.lib (if you use DRM)

See also

IWMReaderPlaylistBurn Interface