IWMProfile::GetName method

The GetName method retrieves the name of a profile.

Syntax

HRESULT GetName(
  WCHAR *pwszName,
  DWORD *pcchName
);

Parameters

pwszName

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

pcchName

On input, specifies the length of the pwszName buffer. On output, if the method succeeds, specifies a pointer to 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 pcchName parameter is NULL.
ASF_E_BUFFERTOOSMALL
The pwszName parameter is not large enough.
E_UNEXPECTED
The method failed for an unspecified reason.

Remarks

You should make two calls to GetName. 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 character, required to hold the profile 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.

Profiles have names and descriptions that are used when displaying lists of profiles.

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

IWMProfile Interface

IWMProfile2

IWMProfile3

IWMProfile::SetName