IMFAudioPolicy::GetIconPath method (mfidl.h)

Retrieves the icon resource for the audio session. The Windows volume control displays this icon.

Syntax

HRESULT GetIconPath(
  [out] LPWSTR *pszPath
);

Parameters

[out] pszPath

Receives a pointer to a wide-character string that specifies a shell resource. The format of the string is described in the topic IMFAudioPolicy::SetIconPath. The caller must free the memory allocated for the string by calling CoTaskMemFree.

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.

Remarks

If the application did not set an icon path, the method returns an empty string ("").

For more information, see IAudioSessionControl::GetIconPath in the core audio API documentation.

Requirements

   
Minimum supported client Windows Vista [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Target Platform Windows
Header mfidl.h
Library Mfuuid.lib

See also

IMFAudioPolicy

Streaming Audio Renderer