IWMStreamConfig::SetStreamName method

The SetStreamName method assigns a name to the stream represented by the stream configuration object.

Syntax

HRESULT SetStreamName(
  LPCWSTR_WMSDK_TYPE_SAFE pwszStreamName
);

Parameters

pwszStreamName

Pointer to a wide-character null-terminated string containing the stream name. Stream names are limited to 256 wide characters.

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 pwszStreamName parameter is NULL.

Remarks

This method is purely for the convenience of the developer during profile manipulation and file writing. The name assigned using this method is not stored in the header section of ASF files created using the profile and is therefore not available through the reader object or synchronous reader object.

The new value will not take effect in the profile until you call IWMProfile::ReconfigStream.

Requirements

   
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

IWMStreamConfig Interface

IWMStreamConfig::GetStreamName