m+I=monitor - ImageMagick Progress Monitor Methods>j Pair








NAME

5

monitor - ImageMagick Progress Monitor Methods






(

SYNOPSIS

Š

unsigned int MagickMonitor( const char *text, const off_t quantum, const size_t span, ExceptionInfo *exception );

T

MonitorHandler SetMonitorHandler( MonitorHandler handler );






B

FUNCTION DESCRIPTIONS





2

MagickMonitor

6
MagickMonitor() calls the monitor handler method with a text string that describes the task and a measure of completion. The method returns True on success otherwise False if an error is encountered, e.g. if there was a user interrupt.

The format of the MagickMonitor method is:

â
unsigned int MagickMonitor ( const char *text, const off_t quantum, const size_t span, ExceptionInfo *exception );

A description of each parameter follows:


E
o quantum:


vThe position relative to the span parameter which represents how much progress has been made toward completing a task.


?
o span:


'The span relative to completing a task.


I
o exception:


0Return any errors or warnings in this structure.





:

SetMonitorHandler

½
SetMonitorHandler() sets the monitor handler to the specified method and returns the previous monitor handler.

The format of the SetMonitorHandler method is:

MonitorHandler SetMonitorHandler ( MonitorHandler handler );

A description of each parameter follows:


E
o handler:


3Specifies a pointer to a method to handle monitors.