ExtractIconA 関数 (shellapi.h)

  • [アーティクル]

指定した実行可能ファイル、DLL、またはアイコン ファイルからアイコンへのハンドルを取得します。

大きいアイコンまたは小さいアイコンのハンドルの配列を取得するには、 ExtractIconEx 関数を使用します。

構文

HICON ExtractIconA(
  [in] HINSTANCE hInst,
  [in] LPCSTR    pszExeFileName,
       UINT      nIconIndex
);

パラメーター

[in] hInst

種類: HINSTANCE

関数を呼び出すアプリケーションのインスタンスを処理します。

[in] pszExeFileName

種類: LPCTSTR

実行可能ファイル、DLL、またはアイコン ファイルの名前を指定する null で終わる文字列へのポインター。

nIconIndex

型: UINT

取得するアイコンの 0 から始まるインデックスを指定します。 たとえば、この値が 0 の場合、関数は指定されたファイルの最初のアイコンへのハンドルを返します。

この値が -1 の場合、関数は指定したファイル内のアイコンの合計数を返します。 ファイルが実行可能ファイルまたは DLL の場合、戻り値はRT_GROUP_ICONリソースの数です。 ファイルが の場合。ICO ファイル、戻り値は 1 です。

この値が -1 と等しくない負の数の場合、関数は、リソース識別子が nIconIndex の絶対値と等しい指定されたファイル内のアイコンへのハンドルを返します。 たとえば、–3 を使用して、リソース識別子が 3 のアイコンを抽出する必要があります。 リソース識別子が 1 のアイコンを抽出するには、 ExtractIconEx 関数を使用します。

戻り値

種類: HICON

戻り値はアイコンへのハンドルです。 指定されたファイルが実行可能ファイル、DLL、またはアイコン ファイルでない場合、戻り値は 1 です。 ファイルにアイコンが見つからなかった場合、戻り値は NULL です。

注釈

不要になったら、DestroyIcon 関数を呼び出して ExtractIcon によって返されるアイコン ハンドルを破棄する必要があります。

注意

shellapi.h ヘッダーは ExtractIcon をエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

要件 値
サポートされている最小のクライアント Windows XP (デスクトップ アプリのみ)
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー shellapi.h
[DLL] Shell32.dll
API セット ext-ms-win-shell-shell32-l1-2-1 (Windows 10 バージョン 10.0.10240 で導入)

こちらもご覧ください

ExtractAssociatedIcon

ExtractAssociatedIconEx

ExtractIconEx