LookupIconIdFromDirectoryEx 関数 (winuser.h)

[アーティクル]
05/25/2023

アイコン (RT_GROUP_ICON) またはカーソル (RT_GROUP_CURSOR) リソースデータを検索して、現在のディスプレイデバイスに最適なアイコンまたはカーソルを検索します。

リソースグループに複数のイメージが存在する場合、このメソッドは次の条件を使用してイメージを選択します。

要求されたサイズを超えないが最も近いイメージが選択されています。
そのサイズの画像が 2 つ以上存在する場合は、ディスプレイの色深度に一致するものが選択されます。
ディスプレイの色深度と完全に一致する画像がない場合は、ディスプレイの色深度を超えない最大の色深度を持つ画像が選択されます。すべて色深度を超える場合は、色深度が最も低いものが選択されます。

構文

int LookupIconIdFromDirectoryEx(
  [in] PBYTE presbits,
  [in] BOOL  fIcon,
  [in] int   cxDesired,
  [in] int   cyDesired,
  [in] UINT  Flags
);

パラメーター

[in] presbits

種類: PBYTE

アイコンまたはカーソルディレクトリデータ。この関数はリソースデータを検証しないため、一般的な保護 (GP) エラーが発生するか、 プリビット が有効なリソースデータを指していない場合は未定義の値を返します。

[in] fIcon

種類: BOOL

アイコンまたはカーソルが求められるかどうかを示します。このパラメーターが TRUE の場合、関数はアイコンを検索しています。パラメーターが FALSE の場合、関数はカーソルを検索しています。

[in] cxDesired

型: int

アイコンの目的の幅 (ピクセル単位)。このパラメーターが 0 の場合、関数は SM_CXICON またはシステムメトリック値 SM_CXCURSOR 使用します。

[in] cyDesired

型: int

アイコンの目的の高さ (ピクセル単位)。このパラメーターが 0 の場合、関数は SM_CYICON またはシステムメトリック値 SM_CYCURSOR 使用します。

[in] Flags

型: UINT

次の値の組み合わせ。

値	意味
LR_DEFAULTCOLOR 0x00000000	既定の色形式を使用します。
LR_MONOCHROME 0x00000001	モノクロアイコンまたはカーソルを作成します。

戻り値

型: int

関数が成功した場合、戻り値は、現在のディスプレイデバイスに最適なアイコン (RT_ICON) またはカーソル (RT_CURSOR) の整数リソース識別子です。

関数が失敗した場合は、0 を返します。詳細なエラー情報を得るには、GetLastError を呼び出します。

解説

RT_GROUP_ICON型のリソースファイル (カーソルを示RT_GROUP_CURSOR) には、デバイスに依存する形式とデバイスに依存しない複数の形式のアイコン (カーソル) データが含まれています。 LookupIconIdFromDirectoryEx は、リソースファイルで、現在のディスプレイデバイスに最適なアイコン (またはカーソル) を検索し、その整数識別子を返します。 FindResource 関数と FindResourceEx 関数は、この識別子を持つ MAKEINTRESOURCE マクロを使用して、モジュール内のリソースを検索します。

アイコンディレクトリは、リソースの種類 がRT_GROUP_ICON (カーソルの 場合はRT_GROUP_CURSOR )、読み込まれる特定のアイコン (RT_ICON) またはカーソル (RT_CURSOR) の整数リソース名を持つリソースファイルから読み込まれます。 LoadResource 関数と CreateIconFromResourceEx 関数を使用して、対応するアイコンまたはカーソルを作成できます。

LoadIcon、LoadImage、および LoadCursor 関数は、この関数を使用して、指定されたリソースデータで、現在のディスプレイデバイスに最適なアイコンまたはカーソルを検索します。 LoadIconWithScaleDown では、最適な代替検索条件が使用されます。

例

例については、「共有アイコンリソース」を参照してください。

要件


サポートされている最小のクライアント	Windows 2000 Professional [デスクトップアプリのみ]
サポートされている最小のサーバー	Windows 2000 Server [デスクトップアプリのみ]
対象プラットフォーム	Windows
ヘッダー	winuser.h (Windows.h を含む)
Library	User32.lib
[DLL]	User32.dll