Share via

IUPnPDevice::IconURL (Windows Embedded CE 6.0)

  • Article

1/6/2010

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

Syntax

HRESULT IconURL(
  BSTR bstrEncodingFormat,
  LONG lSizeX,
  LONG lSizeY,
  LONG lBitDepth,
  BSTR* pbstrIconURL
);

Parameters

  • bstrEncodingFormat
    [in] Specifies the MIME type of the encoding format that is requested for the icon.
  • lSizeX
    [in] Specifies the width of the icon, in pixels. Standard values are 16, 32, or 48.
  • lSizeY
    [in] Specifies the height of the icon, in pixels. Standard values are 16, 32, or 48 pixels.
  • lBitDepth
    [in] Specifies the bit depth of the icon. Standard values are 8, 16, or 24.
  • pbstrIconURL
    [out] Receives a reference to a string that contains the URL from which the icon is to be loaded. This string must be released when it is no longer required.

Return Value

  • S_OK
    This method was successful.

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

Header upnp.h
Library uuid.lib
Windows Embedded CE Windows CE .NET 4.0 and later

See Also

Reference

IUPnPDevice