IWMStreamConfig::GetConnectionName method

The GetConnectionName method retrieves the input name given to the stream.

Syntax

HRESULT GetConnectionName(
  WCHAR *pwszInputName,
  WORD  *pcchInputName
);

Parameters

pwszInputName

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

pcchInputName

On input, a pointer to a variable containing the length of the pwszInputName array in wide characters (2 bytes). On output, if the method succeeds, the variable contains the 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 pcchInputName parameter is NULL.
ASF_E_BUFFERTOOSMALL
The name value contained in the pcchInputName parameter is too large for the pwszInputName array.

Remarks

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

The connection 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 connection name.

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::SetConnectionName