Share via

IWMDMDevice::GetDeviceIcon

  • Article
banner art

The GetDeviceIcon method retrieves a handle to the icon for the device.

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 and service provider 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 a complete 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

The device service provider specifies which icon to retrieve. Before using it, the caller must cast the retrieved ULONG handle to a HICON. When the application is finished with the icon, it must call DestroyIcon to free the memory. DestroyIcon is a standard Win32 function.

Requirements

Header: Defined in wmdm.idl.

Library: mssachlp.lib

See Also