CLIPOBJ_cEnumStart-Funktion (winddi.h)
Die CLIPOBJ_cEnumStart-Funktion legt Parameter zum Aufzählen von Rechtecken in einem angegebenen Clipbereich fest.
Syntax
ENGAPI ULONG CLIPOBJ_cEnumStart(
[in] CLIPOBJ *pco,
[in] BOOL bAll,
[in] ULONG iType,
[in] ULONG iDirection,
[in] ULONG cLimit
);
Parameter
[in] pco
Zeiger auf die CLIPOBJ-Struktur , die den aufzulistenden Clipbereich definiert.
[in] bAll
Gibt an, ob die gesamte Region aufgelistet werden soll. Dieser Parameter ist TRUE , wenn der gesamte Bereich aufgezählt werden soll. Es ist FALSE , wenn nur die teile aufgelistet werden sollen, die für den vorliegenden Zeichnungsvorgang relevant sind.
Ein Treiber, der Clipbereiche zwischenspeichert, muss die gesamte Region auflisten.
[in] iType
Gibt die Datenstrukturen an, die von CLIPOBJ_bEnum geschrieben werden sollen. Dieser Parameter muss derzeit CT_RECTANGLES sein, was angibt, dass der Bereich als Liste von Rechtecken aufgelistet werden soll.
[in] iDirection
Bestimmt die Reihenfolge, in der die Rechtecke aufgezählt werden sollen. Diese Reihenfolge kann entscheidend sein, wenn ein DrvBitBlt-Vorgang gleichzeitig auf derselben Oberfläche ausgeführt wird. Wenn die Reihenfolge für den Gerätetreiber nicht relevant ist, sollte CD_ANY für komplexe Regionen angegeben werden, sodass GDI die Enumeration optimieren kann. Die folgenden Werte sind möglich:
| Wert | Bedeutung |
|---|---|
| CD_ANY | Jeder Auftrag, der für GDI geeignet ist. |
| CD_LEFTDOWN | Von rechts nach links, von oben nach unten. |
| CD_LEFTUP | Von rechts nach links, von unten nach oben. |
| CD_RIGHTDOWN | Von links nach rechts, von oben nach unten. |
| CD_RIGHTUP | Von links nach rechts, von unten nach oben. |
[in] cLimit
Gibt die maximale Anzahl von Rechtecken an, die aufgezählt werden sollen. Wenn dieser Parameter null ist, wird die Zählung ausgelassen.
Rückgabewert
Der Rückgabewert ist die Anzahl der aufgezählten Rechtecke. Wenn die Anzahl cLimit überschreitet, wird der Rückgabewert 0xFFFFFFFF.
Hinweise
Ein Bereich kann aufgezählt werden, ob diese Funktion aufgerufen wird. Standardmäßig listet der Treiber nur relevante Rechtecke auf, beginnend am oberen linken Rand.
Der Treiber kann die Enumeration neu starten, indem er diese Funktion erneut aufruft.
Anforderungen
| Unterstützte Mindestversion (Client) | Verfügbar in Windows 2000 und höheren Versionen der Windows-Betriebssysteme. |
| Zielplattform | Universell |
| Header | winddi.h (einschließlich Winddi.h) |
| Bibliothek | Win32k.lib |
| DLL | Win32k.sys |