IWMInputMediaProps::GetConnectionName 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 GetConnectionName method retrieves the connection name specified in the profile.
Syntax
HRESULT GetConnectionName(
[out] WCHAR *pwszName,
[in, out] WORD *pcchName
);
Parameters
[out] pwszName
Pointer to a wide-character null-terminated string containing the connection name. Pass NULL to retrieve the length required for the name.
[in, out] pcchName
On input, a pointer to a variable containing the length of the pwszName 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 |
|---|---|
|
The method succeeded. |
|
The pcchName parameter is NULL. |
|
The pwszName parameter is not large enough. |
Remarks
You should make two calls to GetConnectionName. On the first call, pass NULL as pwszName. On return, the value pointed to by pcchName is set to the number of wide characters, including the terminating null, 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 pwszName on the second call.
The connection name is the same as the input name specified on one (or more) of the streams in the profile, so it can be used to match writer inputs to profile streams.
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) |