IWMSyncReader::GetOutputFormat 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 GetOutputFormat method retrieves the supported formats for a specified output media stream.

Syntax

HRESULT GetOutputFormat(
  [in]  DWORD               dwOutputNum,
  [in]  DWORD               dwFormatNum,
  [out] IWMOutputMediaProps **ppProps
);

Parameters

[in] dwOutputNum

DWORD containing the output number.

[in] dwFormatNum

DWORD containing the format number.

[out] ppProps

Pointer to a pointer to an IWMOutputMediaProps interface. This object is created by a successful call to this method.

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_POINTER	ppProps is NULL.
E_UNEXPECTED	No file is open in the synchronous reader.

Remarks

To enumerate the supported formats for an output media stream, call GetOutputFormatCount to get the number of formats, and then call GetOutputFormat in succession to get the formats.

Requirements


Minimum supported client	Windows 2000 Professional [desktop apps only],Windows Media Format 9 Series 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