PrivateExtractIconsW 関数 (winuser.h)

  • [アーティクル]

[この関数は、一般的な使用を目的としたものではありません。 それ以降のバージョンの Windows では、変更または使用できない場合があります。

指定したファイルから抽出されたアイコンへのハンドルの配列を作成します。

構文

UINT PrivateExtractIconsW(
  [in]            LPCWSTR szFileName,
  [in]            int     nIconIndex,
  [in]            int     cxIcon,
  [in]            int     cyIcon,
  [out, optional] HICON   *phicon,
  [out, optional] UINT    *piconid,
  [in]            UINT    nIcons,
  [in]            UINT    flags
);

パラメーター

[in] szFileName

種類: LPCTSTR

アイコンの抽出元となるファイルのパスと名前。

[in] nIconIndex

型: int

抽出する最初のアイコンの 0 から始まるインデックス。 たとえば、この値が 0 の場合、関数は指定したファイル内の最初のアイコンを抽出します。

[in] cxIcon

型: int

水平アイコンのサイズが必要です。 「解説」を参照してください。

[in] cyIcon

型: int

縦のアイコン のサイズが必要です。 「解説」を参照してください。

[out, optional] phicon

種類: HICON*

返されたアイコン ハンドルの配列へのポインター。

[out, optional] piconid

型: UINT*

現在のディスプレイ デバイスに最適なアイコンの、返されたリソース識別子へのポインター。 この形式で識別子を使用できない場合、返される識別子は0xFFFFFFFFされます。 それ以外の場合、識別子を取得できない場合、返される識別子は 0 です。

[in] nIcons

型: UINT

ファイルから抽出するアイコンの数。 このパラメーターは、.exe ファイルと .dll ファイルから抽出する場合にのみ有効です。

[in] flags

型: UINT

この関数を制御するフラグを指定します。 これらのフラグは、 LoadImage 関数によって使用されるLR_* フラグです。

戻り値

型: UINT

phicon パラメーターが NULL で、この関数が成功した場合、戻り値はファイル内のアイコンの数になります。 関数が失敗した場合、戻り値は 0 になります。

phicon パラメーターが NULL ではなく、関数が成功した場合、戻り値は抽出されたアイコンの数になります。 それ以外の場合、ファイルが見つからない場合、戻り値は0xFFFFFFFFされます。

解説

この関数は、実行可能ファイル (.exe)、DLL (.dll)、アイコン (.ico)、カーソル (.cur)、アニメーション カーソル (.ani)、ビットマップ (.bmp) ファイルから抽出します。 Windows 3.x 16 ビット実行可能ファイル (.exe または .dll) からの抽出もサポートされています。

cxIcon パラメーターと cyIcon パラメーターは、抽出するアイコンのサイズを指定します。 パラメーターの LOWORD に最初のサイズを、HIWORD に 2 番目のサイズを入れることで、2 つのサイズを抽出できます。 たとえば、 MAKELONG(24, 48) cxIcon パラメーターと cyIcon パラメーターの両方で、24 と 48 の両方のサイズ のアイコンが抽出されます。

DestroyIcon 関数を呼び出して、PrivateExtractIcons によって抽出されたすべてのアイコンを破棄する必要があります。

この関数は、Windows XP Service Pack 1 (SP1) と Windows Server 2003 まで SDK ヘッダーとライブラリに含まれていませんでした。 この関数のヘッダー ファイルとインポート ライブラリがない場合は、 LoadLibrary と GetProcAddress を使用して関数を呼び出すことができます。

注意

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

要件

   
サポートされている最小のクライアント Windows 2000 Professional [デスクトップ アプリのみ]
サポートされている最小のサーバー Windows 2000 Server [デスクトップ アプリのみ]
対象プラットフォーム Windows
ヘッダー winuser.h
Library User32.lib
[DLL] User32.dll
API セット ext-ms-win-ntuser-misc-l1-5-1 (Windows 10 バージョン 10.0.14393 で導入)

関連項目

概念

DestroyIcon

ExtractIcon

ExtractIconEx

アイコン

参照