IControlInterface::GetName method (devicetopology.h)

Article
02/22/2024

The GetName method gets the friendly name for the audio function that the control interface encapsulates.

Syntax

HRESULT GetName(
  [out] LPWSTR *ppwstrName
);

Parameters

[out] ppwstrName

Pointer to a string pointer into which the method writes the address of a null-terminated, wide-character string that contains the friendly name. The method allocates the storage for the string. The caller is responsible for freeing the storage, when it is no longer needed, by calling the CoTaskMemFree function. If the GetName call fails, *ppwstrName is NULL. For information about CoTaskMemFree, see the Windows SDK documentation.

Return value

If the method succeeds, it returns S_OK. If it fails, possible return codes include, but are not limited to, the values shown in the following table.

Return code	Description
E_POINTER	Pointer ppwstrName is NULL.
E_OUTOFMEMORY	Out of memory.

Remarks

As an example of a friendly name, a subunit with an IAudioPeakMeter interface might have the friendly name "peak meter".

Requirements

Requirement	Value
Minimum supported client	Windows Vista [desktop apps only]
Minimum supported server	Windows Server 2008 [desktop apps only]
Target Platform	Windows
Header	devicetopology.h