IWMProfile::GetStreamByNumber 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 GetStreamByNumber method retrieves a stream from the profile.

Syntax

HRESULT GetStreamByNumber(
  [in]  WORD            wStreamNum,
  [out] IWMStreamConfig **ppConfig
);

Parameters

[in] wStreamNum

WORD containing the stream number.

[out] ppConfig

Pointer to a pointer to the IWMStreamConfig interface of the stream configuration object that describes the specified stream.

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
The ppConfig parameter is NULL.
NS_E_NO_STREAM
The wStreamNum parameter is not valid.
E_FAIL
The method failed for an unspecified reason.

Remarks

Stream numbers are in the range of 1 through 63.

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

IWMProfile Interface

IWMProfile2

IWMProfile3

IWMProfile::GetStream

IWMProfile::RemoveStreamByNumber