IWMWriter::SetOutputFilename 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 SetOutputFilename method specifies the name of the file to be written.

Syntax

HRESULT SetOutputFilename(
  [in] const WCHAR *pwszFilename
);

Parameters

[in] pwszFilename

Pointer to a wide-character null-terminated string containing the file name.

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.
E_UNEXPECTED
The method failed for an unspecified reason.
NS_E_INVALID_STATE
The writer is not in a configurable state.

Remarks

This method is equivalent to creating a file sink with an index of 0 and adding it through a call to IWMWriterAdvanced::AddSink, and is provided for convenience.

You can obtain a pointer to the IWMWriterSink interface of the file sink created by this method by calling IWMWriterAdvanced::GetSink. This is important because the writer does not deliver status messages for the sinks associated with it. You can call QueryInterface on IWMWriterSink to obtain a pointer to the IWMRegisterCallback, which is used to set an IWMStatusCallback::OnStatus callback method to which the sink will deliver status messages.

Requirements

Requirement Value
Minimum supported client Windows 2000 Professional [desktop apps only],Windows Media Format 7 SDK, or later versions of the SDK
Minimum supported server Windows 2000 Server [desktop apps only]
Target Platform Windows
Header wmsdkidl.h (include Wmsdk.h)
Library Wmvcore.lib; WMStubDRM.lib (if you use DRM)

See also

IWMWriter Interface

Using File Sinks