IWMDMDevice::GetDeviceIcon (deprecated)

banner art

This is preliminary documentation and subject to change.

This topic documents a feature of the Windows Media Device Manager SDK. We recommend that you migrate your application to use the Windows Portable Devices API. For more information, see the Windows Portable Devices SDK.

The GetDeviceIcon method retrieves a handle to the icon that the device manufacturer wants to display when the device is connected.

Syntax

HRESULT GetDeviceIcon(
  ULONG*  hIcon
);

Parameters

hIcon

[out]  Handle to an icon object.

Return Values

The method returns an HRESULT. All the interface methods in Windows Media Device Manager can return any of the following classes of error codes:

  • Standard COM error codes
  • Windows error codes converted to HRESULT values
  • Windows Media Device Manager error codes

For an extenstive list of possible error codes, see Error Codes.

Possible values include, but are not limited to, those in the following table.

Return code Description
S_OK The method succeeded.
E_INVALIDARG The hIcon parameter is either an invalid or NULL pointer.
E_FAIL An unspecified error occurred.

Remarks

When the application is finished with the icon, it must call the Win32 DestroyIcon function to free the memory.

Requirements

Header: Defined in mswmdm.h.

Library: mssachlp.lib

See Also