IExtractIconA::Extract-Methode (shlobj_core.h)

Extrahiert ein Symbolbild aus dem angegebenen Speicherort.

Syntax

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

Parameter

[in] pszFile

Typ: PCTSTR

Ein Zeiger auf eine NULL-endende Zeichenfolge, die den Symbolspeicherort angibt.

nIconIndex

Typ: UINT

Der Index des Symbols in der Datei, auf die pszFile verweist.

[out, optional] phiconLarge

Typ: HICON*

Ein Zeiger auf einen HICON-Wert , der das Handle auf das große Symbol empfängt. Dieser Parameter kann NULL sein.

[out, optional] phiconSmall

Typ: HICON*

Ein Zeiger auf einen HICON-Wert , der das Handle auf das kleine Symbol empfängt. Dieser Parameter kann NULL sein.

nIconSize

Typ: UINT

Die gewünschte Größe des Symbols in Pixel. Das niedrige Wort enthält die Größe des großen Symbols, und das hohe Wort enthält die Größe des kleinen Symbols. Die angegebene Größe kann die Breite oder Höhe sein. Die Breite eines Symbols entspricht immer seiner Höhe.

Rückgabewert

Typ: HRESULT

Gibt S_OK zurück, wenn die Funktion das Symbol extrahiert hat, oder S_FALSE, wenn die aufrufende Anwendung das Symbol extrahieren soll.

Hinweise

Symbolposition und Index sind die gleichen Werte, die von der IExtractIcon::GetIconLocation-Methode zurückgegeben werden. Wenn die IExtractIcon::Extract-Funktion S_FALSE zurückgibt, müssen diese Werte einen Symboldateinamen und einen Index angeben, die rechtliche Parameter für einen Aufruf von ExtractIcon bilden. Wenn IExtractIcon::Extract keine S_FALSE zurückgibt, sollten keine Annahmen über die Bedeutung der Parameter pszFile und nIconIndex getroffen werden.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows XP [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows 2000 Server [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile shlobj_core.h
DLL Shell32.dll (Version 4.0 oder höher)

Weitere Informationen

IExtractIcon