IExtractIconW::Extract メソッド (shlobj_core.h)

指定した場所からアイコン イメージを抽出します。

構文

HRESULT Extract(
  [in]            PCWSTR pszFile,
                  UINT   nIconIndex,
  [out, optional] HICON  *phiconLarge,
  [out, optional] HICON  *phiconSmall,
                  UINT   nIconSize
);

パラメーター

[in] pszFile

種類: PCTSTR

アイコンの場所を指定する null で終わる文字列へのポインター。

nIconIndex

型: UINT

pszFile が指すファイル内のアイコンのインデックス。

[out, optional] phiconLarge

種類: HICON*

大きなアイコンへのハンドルを受け取る HICON 値へのポインター。 このパラメーターには NULL を指定できます。

[out, optional] phiconSmall

種類: HICON*

小さいアイコンへのハンドルを受け取る HICON 値へのポインター。 このパラメーターには NULL を指定できます。

nIconSize

型: UINT

アイコンの目的のサイズ (ピクセル単位)。 低い単語には大きなアイコンのサイズが含まれており、高い単語には小さいアイコンのサイズが含まれています。 指定するサイズには、幅または高さを指定できます。 アイコンの幅は常に高さと同じです。

戻り値

種類: HRESULT

関数がアイコンを抽出した場合はS_OKを返し、呼び出し元のアプリケーションがアイコンを抽出する必要がある場合はS_FALSEを返します。

解説

アイコンの場所とインデックスは、 IExtractIcon::GetIconLocation メソッドによって返される値と同じです。 IExtractIcon::Extract 関数がS_FALSEを返す場合、これらの値には、ExtractIcon の呼び出しの有効なパラメーターを形成するアイコン ファイル名とインデックスを指定する必要があります。 IExtractIcon::Extract がS_FALSEを返さない場合は、pszFile パラメーターと nIconIndex パラメーターの意味を想定しないでください。

要件

関連項目

IExtractIcon