IWMWriterAdvanced::GetSink method (wmsdkidl.h)

Article
4/26/2023

[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 GetSink method retrieves a writer sink object. Used in conjunction with IWMWriterAdvanced::GetSinkCount, this method can be used to enumerate the sinks associated with a writer object.

Syntax

HRESULT GetSink(
  [in]  DWORD         dwSinkNum,
  [out] IWMWriterSink **ppSink
);

Parameters

[in] dwSinkNum

DWORD containing the sink number (its index). This is a number between 0 and one less than the total number of sinks associated with the file as obtained with IWMWriterAdvanced::GetSinkCount.

[out] ppSink

Pointer to a pointer to an IWMWriterSink interface.

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_INVALIDARG	Either the ppSink parameter is NULL, or the dwSinkNum parameter is greater than the number of sinks.

Remarks

You can use GetSink to gain access to the file sink that is automatically created when you call IWMWriter::SetOutputFilename. If you are only writing to the automatically created file sink, it will always be sink number 0.

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)

Share via