IWMStreamConfig::GetStreamName 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 GetStreamName method retrieves the stream name.

Syntax

HRESULT GetStreamName(
  [out]     WCHAR *pwszStreamName,
  [in, out] WORD  *pcchStreamName
);

Parameters

[out] pwszStreamName

Pointer to a wide-character null-terminated string containing the stream name. Pass NULL to retrieve the length of the name.

[in, out] pcchStreamName

On input, a pointer to a variable containing the length of the pwszStreamName array in wide characters (2 bytes). On output, if the method succeeds, the variable contains the actual length of the name, including the terminating null character.

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 pcchStreamName parameter is NULL.
ASF_E_BUFFERTOOSMALL	The name value contained in the pcchStreamName parameter is too large for the pwszStreamName array.

Remarks

You should make two calls to GetStreamName. On the first call, pass NULL as pwszStreamName. On return, the value pointed to by pcchStreamName is set to the number of wide characters, including the terminating null character, required to hold the stream name. Then you can allocate the required amount of memory for the string and pass a pointer to it as pwszStreamName on the second call.

The stream name is not written to the header section of an ASF file. If you obtain the IWMStreamConfig interface from the reader object or synchronous reader object, you cannot retrieve the original stream name.

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