Edit

Share via

IUPnPDevice::IconURL method (upnp.h)

  • Article

The IconURL method returns a URL from which an icon of the specified format can be loaded.

Syntax

HRESULT IconURL(
  [in]  BSTR bstrEncodingFormat,
  [in]  LONG lSizeX,
  [in]  LONG lSizeY,
  [in]  LONG lBitDepth,
  [out] BSTR *pbstrIconURL
);

Parameters

[in] bstrEncodingFormat

Specifies the MIME type of the encoding format that is requested for the icon.

[in] lSizeX

Specifies the width of the icon, in pixels. Standard values are 16, 32, or 48.

[in] lSizeY

Specifies the height of the icon, in pixels. Standard values are 16, 32, or 48 pixels.

[in] lBitDepth

Specifies the bit depth of the icon. Standard values are 8, 16, or 24.

[out] pbstrIconURL

Receives a reference to a string that contains the URL from which the icon is to be loaded. Release this string with SysFreeString when it is no longer required.

Return value

If the method succeeds, the return value is S_OK. Otherwise, the method returns one of the COM error codes defined in WinError.h.

Remarks

An application can specify any values for lSizeX, lSizeY, and lBitDepth. However, there is no guarantee that an icon exists with those specifications.

If a matching icon does not exist, the URL for the icon that most closely matches the size and bit depth specified is returned.

Requirements

Requirement Value
Minimum supported client Windows XP [desktop apps only]
Minimum supported server None supported
Target Platform Windows
Header upnp.h
DLL Upnp.dll

See also

IUPnPDevice