función CLIPOBJ_cEnumStart (winddi.h)

La función CLIPOBJ_cEnumStart establece parámetros para enumerar rectángulos en una región de recorte especificada.

Sintaxis

ENGAPI ULONG CLIPOBJ_cEnumStart(
  [in] CLIPOBJ *pco,
  [in] BOOL    bAll,
  [in] ULONG   iType,
  [in] ULONG   iDirection,
  [in] ULONG   cLimit
);

Parámetros

[in] pco

Puntero a la estructura CLIPOBJ que define la región del clip que se va a enumerar.

[in] bAll

Especifica si se debe enumerar toda la región. Este parámetro es TRUE si se debe enumerar toda la región. Es FALSE si solo se deben enumerar las partes pertinentes para la operación de dibujo actual.

Un controlador que almacena en caché las regiones de recorte debe enumerar toda la región.

[in] iType

Especifica las estructuras de datos que se van a escribir mediante CLIPOBJ_bEnum. Actualmente, este parámetro debe ser CT_RECTANGLES, lo que indica que la región se va a enumerar como una lista de rectángulos.

[in] iDirection

Determina el orden en que se van a enumerar los rectángulos. Este orden puede ser esencial si una operación DrvBitBlt se ejecuta simultáneamente en la misma superficie. Si el orden no es relevante para el controlador de dispositivo, se debe especificar CD_ANY para regiones complejas, lo que permite que GDI optimice la enumeración. Este valor puede ser uno de los siguientes:

Valor	Significado
CD_ANY	Cualquier pedido conveniente para GDI.
CD_LEFTDOWN	De derecha a izquierda, arriba abajo.
CD_LEFTUP	De derecha a izquierda, de abajo a arriba.
CD_RIGHTDOWN	De izquierda a derecha, arriba abajo.
CD_RIGHTUP	De izquierda a derecha, de abajo a arriba.

[in] cLimit

Especifica el número máximo de rectángulos que se van a enumerar. Si este parámetro es cero, se omite el recuento.

Valor devuelto

El valor devuelto es el recuento de rectángulos enumerados. Si el recuento supera cLimit, el valor devuelto se 0xFFFFFFFF.

Comentarios

Se puede enumerar una región si se llama a esta función. De forma predeterminada, el controlador solo enumera los rectángulos pertinentes, empezando por la esquina superior izquierda.

El controlador puede reiniciar la enumeración llamando a esta función de nuevo.

Requisitos

Cliente mínimo compatible	Disponible en Windows 2000 y versiones posteriores de los sistemas operativos Windows.
Plataforma de destino	Universal
Encabezado	winddi.h (incluya Winddi.h)
Library	Win32k.lib
Archivo DLL	Win32k.sys

Consulte también

CLIPOBJ

CLIPOBJ_bEnum

DrvBitBlt