IUPnPDevice::IconURL メソッド (upnp.h)

IconURL メソッドは、指定した形式のアイコンを読み込むことができる URL を返します。

構文

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

[in] bstrEncodingFormat

アイコンに対して要求されるエンコード形式の MIME の種類を指定します。

[in] lSizeX

アイコンの幅をピクセル単位で指定します。標準値は 16、32、または 48 です。

[in] lSizeY

アイコンの高さをピクセル単位で指定します。標準値は 16、32、または 48 ピクセルです。

[in] lBitDepth

アイコンのビット深度を指定します。標準値は 8、16、または 24 です。

[out] pbstrIconURL

アイコンの読み込み元の URL を含む文字列への参照を受け取ります。不要になったら、 SysFreeString を使用してこの文字列を解放します。

メソッドが成功した場合、戻り値はS_OK。それ以外の場合、メソッドは WinError.h で定義されている COM エラーコードのいずれかを返します。

アプリケーションでは、 lSizeX、 lSizeY、および lBitDepth に任意の値を指定できます。ただし、これらの仕様にアイコンが存在する保証はありません。

一致するアイコンが存在しない場合は、指定したサイズとビット深度に最も近いアイコンの URL が返されます。