GdiSetBatchLimit
The GdiSetBatchLimit
function sets the maximum number of functions that can be accumulated in the
calling thread s current batch. The system flushes the current batch
whenever this limit is exceeded.
DWORD GdiSetBatchLimit(
|
DWORD dwLimit |
// batch limit |
|
); |
|
Parameters
dwLimit
Specifies the
batch limit to be set. A value of 0 sets the default limit. A value of 1
disables batching.
Return Values
If the
function succeeds, the return value is the previous batch limit.
If the
function fails, the return value is zero. To get extended error information,
call GetLastError.
Remarks
Only GDI
drawing functions that return Boolean values can be accumulated in the current
batch; calls to any other GDI functions immediately flush the current batch.
Exceeding the batch limit or calling the GdiFlush function also flushes the
current batch.
When the
system accumulates a function, the function returns TRUE to indicate it is in
the batch. When the system flushes the current batch and executes the function
for the second time, the return value is either TRUE or FALSE, depending on
whether the function succeeds. This second return value is reported only if GdiFlush
is used to flush the batch.
Note that the
batch limit is maintained for each thread separately. In order to completely
disable batching, call GdiSetBatchLimit(1) during the initialization of
each thread.
See Also