CLIPOBJ_cEnumStart, fonction (winddi.h)
La fonction CLIPOBJ_cEnumStart définit les paramètres d’énumération des rectangles dans une région de clip spécifiée.
Syntaxe
ENGAPI ULONG CLIPOBJ_cEnumStart(
[in] CLIPOBJ *pco,
[in] BOOL bAll,
[in] ULONG iType,
[in] ULONG iDirection,
[in] ULONG cLimit
);
Paramètres
[in] pco
Pointeur vers la structure CLIPOBJ qui définit la région de clip à énumérer.
[in] bAll
Spécifie si la région entière doit être énumérée. Ce paramètre a la valeur TRUE si toute la région doit être énumérée. Elle a la valeur FALSE si seules les parties pertinentes pour l’opération de dessin actuelle doivent être énumérées.
Un pilote qui met en cache des régions de clip doit énumérer la région entière.
[in] iType
Spécifie les structures de données qui doivent être écrites par CLIPOBJ_bEnum. Ce paramètre doit actuellement être CT_RECTANGLES, ce qui indique que la région doit être énumérée sous la forme d’une liste de rectangles.
[in] iDirection
Détermine l’ordre dans lequel les rectangles doivent être énumérés. Cet ordre peut être essentiel si une opération DrvBitBlt s’exécute simultanément sur la même surface. Si l’ordre n’est pas pertinent pour le pilote de périphérique, CD_ANY doit être spécifié pour les régions complexes, ce qui permet à GDI d’optimiser l’énumération. Cette valeur peut être l'une des suivantes :
| Valeur | Signification |
|---|---|
| CD_ANY | Toute commande pratique pour GDI. |
| CD_LEFTDOWN | De droite à gauche, de haut en bas. |
| CD_LEFTUP | De droite à gauche, de bas en haut. |
| CD_RIGHTDOWN | De gauche à droite, de haut en bas. |
| CD_RIGHTUP | De gauche à droite, de bas en haut. |
[in] cLimit
Spécifie le nombre maximal de rectangles à énumérer. Si ce paramètre est égal à zéro, le comptage est omis.
Valeur retournée
La valeur de retour est le nombre de rectangles énumérés. Si le nombre dépasse cLimit, la valeur de retour est 0xFFFFFFFF.
Remarques
Une région peut être énumérée si cette fonction est appelée. Par défaut, le pilote énumère uniquement les rectangles pertinents, en commençant en haut à gauche.
Le pilote peut redémarrer l’énumération en appelant à nouveau cette fonction.
Configuration requise
| Client minimal pris en charge | Disponible dans Windows 2000 et versions ultérieures des systèmes d’exploitation Windows. |
| Plateforme cible | Universal |
| En-tête | winddi.h (inclure Winddi.h) |
| Bibliothèque | Win32k.lib |
| DLL | Win32k.sys |