ImageList_SetOverlayImage-Funktion (commctrl.h)

Fügt der Liste der Bilder, die als Überlagerungsmasken verwendet werden sollen, ein angegebenes Bild hinzu. Eine Bildliste kann bis zu vier Überlagerungsmasken in Version 4.70 und früher und bis zu 15 in Version 4.71 enthalten. Die Funktion weist dem angegebenen Bild einen Überlagerungsmaskenindex zu.

Syntax

BOOL ImageList_SetOverlayImage(
  [in] HIMAGELIST himl,
  [in] int        iImage,
  [in] int        iOverlay
);

Parameter

[in] himl

Typ: HIMAGELIST

Ein Handle für die Bildliste.

[in] iImage

Typ: int

Der nullbasierte Index eines Bilds in der Himlbildliste . Dieser Index identifiziert das Bild, das als Überlagerungsmaske verwendet werden soll.

[in] iOverlay

Typ: int

Der 1-basierte Index der Überlagerungsmaske.

Rückgabewert

Typ: BOOL

Gibt bei erfolgreicher Ausführung nonzero zurück, oder andernfalls null.

Hinweise

Eine Überlagerungsmaske ist ein Bild, das transparent über ein anderes Bild gezeichnet wird. Um eine Überlagerungsmaske über ein Bild zu zeichnen, rufen Sie die ImageList_Draw- oder ImageList_DrawEx-Funktion auf. Der fStyle-Parameter dieser Funktionen kann das Makro INDEXTOOVERLAYMASK verwenden, um einen Überlagerungsmask-Maskenindex anzugeben.

Ein Aufruf dieser Methode schlägt fehl und gibt E_INVALIDARG zurück, es sei denn, die Bildliste wird mithilfe einer Maske erstellt.

Anforderungen

Anforderung Wert
Unterstützte Mindestversion (Client) Windows Vista [nur Desktop-Apps]
Unterstützte Mindestversion (Server) Windows Server 2003 [nur Desktop-Apps]
Zielplattform Windows
Kopfzeile commctrl.h
Bibliothek Comctl32.lib
DLL Comctl32.dll
APIs ext-ms-win-shell-comctl32-init-l1-1-1 (eingeführt in Windows 10, Version 10.0.14393)