PrivateExtractIconsA-Funktion (winuser.h)

Artikel
08/27/2023

[Diese Funktion ist nicht für die allgemeine Verwendung vorgesehen. Sie kann in nachfolgenden Versionen von Windows geändert oder nicht verfügbar sein.]

Erstellt ein Array von Handles zu Symbolen, die aus einer angegebenen Datei extrahiert werden.

Syntax

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

Parameter

[in] szFileName

Typ: LPCTSTR

Der Pfad und der Name der Datei, aus der die Symbole extrahiert werden sollen.

[in] nIconIndex

Typ: int

Der nullbasierte Index des ersten zu extrahierenden Symbols. Wenn dieser Wert beispielsweise 0 ist, extrahiert die Funktion das erste Symbol in der angegebenen Datei.

[in] cxIcon

Typ: int

Die gewünschte horizontale Symbolgröße. Siehe Hinweise.

[in] cyIcon

Typ: int

Die gewünschte vertikale Symbolgröße. Siehe Hinweise.

[out, optional] phicon

Typ: HICON*

Ein Zeiger auf das zurückgegebene Array von Symbolhandles.

[out, optional] piconid

Typ: UINT*

Ein Zeiger auf einen zurückgegebenen Ressourcenbezeichner für das Symbol, das am besten zum aktuellen Anzeigegerät passt. Der zurückgegebene Bezeichner ist 0xFFFFFFFF, wenn der Bezeichner für dieses Format nicht verfügbar ist. Der zurückgegebene Bezeichner ist 0, wenn der Bezeichner nicht anderweitig abgerufen werden kann.

[in] nIcons

Typ: UINT

Die Anzahl der Symbole, die aus der Datei extrahiert werden sollen. Dieser Parameter ist nur gültig, wenn aus .exe- und .dll-Dateien extrahiert wird.

[in] flags

Typ: UINT

Gibt Flags an, die diese Funktion steuern. Diese Flags sind die LR_*-Flags, die von der LoadImage-Funktion verwendet werden.

Rückgabewert

Typ: UINT

Wenn der phicon-ParameterNULL ist und diese Funktion erfolgreich ist, ist der Rückgabewert die Anzahl der Symbole in der Datei. Wenn bei der Funktion ein Fehler auftritt, ist der Rückgabewert 0.

Wenn der phicon-Parameter nicht NULL ist und die Funktion erfolgreich ist, ist der Rückgabewert die Anzahl der extrahierten Symbole. Andernfalls wird der Rückgabewert 0xFFFFFFFF, wenn die Datei nicht gefunden wird.

Hinweise

Diese Funktion extrahiert aus ausführbaren Dateien (.exe), DLL (.dll), Symbolen (.ico), Cursor (.cur), animierten Cursor (.ani) und Bitmapdateien (.bmp). Extraktionen aus ausführbaren Windows 3.x 16-Bit-Dateien (.exe oder .dll) werden ebenfalls unterstützt.

Die Parameter cxIcon und cyIcon geben die Größe der zu extrahierenden Symbole an. Zwei Größen können extrahiert werden, indem die erste Größe im LOWORD-Parameter und die zweite Größe im HIWORD-Wert festgelegt wird. Beispielsweise MAKELONG(24, 48) würden für die Parameter cxIcon und cyIcon sowohl Symbole der Größe 24 als auch 48 extrahiert.

Sie müssen alle von PrivateExtractIcons extrahierten Symbole zerstören, indem Sie die DestroyIcon-Funktion aufrufen.

Diese Funktion war erst unter Windows XP Service Pack 1 (SP1) und Windows Server 2003 in den SDK-Headern und -Bibliotheken enthalten. Wenn Sie keine Headerdatei und keine Importbibliothek für diese Funktion haben, können Sie die Funktion mit LoadLibrary und GetProcAddress aufrufen.

Hinweis

Der winuser.h-Header definiert PrivateExtractIcons als Alias, der automatisch die ANSI- oder Unicode-Version dieser Funktion basierend auf der Definition der UNICODE-Präprozessorkonstante auswählt. Das Mischen der Verwendung des codierungsneutralen Alias mit nicht codierungsneutralem Code kann zu Nichtübereinstimmungen führen, die zu Kompilierungs- oder Laufzeitfehlern führen. Weitere Informationen finden Sie unter Konventionen für Funktionsprototypen.

Anforderungen


Unterstützte Mindestversion (Client)	Windows 2000 Professional [nur Desktop-Apps]
Unterstützte Mindestversion (Server)	Windows 2000 Server [nur Desktop-Apps]
Zielplattform	Windows
Kopfzeile	winuser.h
Bibliothek	User32.lib
DLL	User32.dll
APIs	ext-ms-win-ntuser-misc-l1-5-1 (eingeführt in Windows 10, Version 10.0.14393)