granicus.if.org Git - imagemagick/blob - www/api/monitor.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
   2     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\r
   4 <head>\r
   5   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
   6   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   7   <style type="text/css" media="screen,projection"><!--\r
   8     @import url("../../www/magick.css");\r
   9   --></style>\r
  10   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  11   <title>ImageMagick: MagickCore, C API for ImageMagick: Monitor the Progress of an Image Operation</title>
  12   <meta http-equiv="Content-Language" content="en-US"/>
  13   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  14   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  15   <meta name="Generator" content="PHP"/>
  16   <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, monitor, the, progress, of, an, image, operation, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
  17   <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.  ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems.  The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
  18   <meta name="Rating" content="GENERAL"/>
  19   <meta name="Robots" content="INDEX, FOLLOW"/>
  20   <meta name="Generator" content="ImageMagick Studio LLC"/>
  21   <meta name="Author" content="ImageMagick Studio LLC"/>
  22   <meta name="Revisit-after" content="2 DAYS"/>
  23   <meta name="Resource-type" content="document"/>
  24   <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
  25   <meta name="Distribution" content="Global"/>
  26 </head>\r
  27 \r
  28 <body id="www-imagemagick-org">\r
  29 <div class="titlebar">\r
  30 <a href="../../index.html">\r
  31   <img src="../../images/script.png" alt="[ImageMagick]"\r
  32   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  33 <a href="http://www.networkredux.com">\r
  34   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  35   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  36 <a href="http://www.imagemagick.org/discourse-server/">\r
  37   <img src="../../images/logo.jpg" alt=""\r
  38   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  39 <a href="../../index.html">\r
  40   <img src="../../images/sprite.jpg" alt=""\r
  41   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  42 </div>\r
  43 \r
  44 <div class="eastbar">\r
  45 \r
  46 <div class="menu">
  47   <a href="../../index.html">About ImageMagick</a>
  48 </div>
  49 <div class="sep"></div>\r
  50 <div class="menu">
  51   <a href="../../www/command-line-tools.html">Command-line Tools</a>
  52 </div>
  53 <div class="sub">
  54     <a href="../../www/command-line-processing.html">Processing</a>
  55 </div>
  56 <div class="sub">
  57     <a href="../../www/command-line-options.html">Options</a>
  58 </div>
  59 <div class="sub">
  60     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  61 </div>
  62 <div class="menu">
  63   <a href="../../www/api.html">Program Interfaces</a>
  64 </div>
  65 <div class="sub">
  66     <a href="../../www/magick-wand.html">MagickWand</a>
  67 </div>
  68 <div class="sub">
  69     <a href="../../www/magick-core.html">MagickCore</a>
  70 </div>
  71 <div class="sub">
  72     <a href="../../www/perl-magick.html">PerlMagick</a>
  73 </div>
  74 <div class="sub">
  75     <a href="../../Magick++/">Magick++</a>
  76 </div>
  77 <div class="menu">
  78   <a href="../../www/architecture.html">Architecture</a>
  79 </div>
  80 <div class="sep"></div>\r
  81 <div  class="menu">
  82    <a href="../../www/install-source.html">Install from Source</a>
  83 </div>
  84 <div class="sub">
  85     <a href="../../www/install-source.html#unix">Unix</a>
  86 </div>
  87 <div class="sub">
  88     <a href="../../www/install-source.html#windows">Windows</a>
  89  </div>
  90 <div class="menu">
  91   <a href="../../www/binary-releases.html">Binary Releases</a>
  92 </div>
  93 <div class="sub">
  94     <a href="../../www/binary-releases.html#unix">Unix</a>
  95 </div>
  96 <div class="sub">
  97     <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
  98 </div>
  99 <div class="sub">
 100     <a href="../../www/binary-releases.html#windows">Windows</a>
 101 </div>
 102 <div class="menu">
 103   <a href="../../www/resources.html">Resources</a>
 104 </div>
 105 <div class="sep"></div>\r
 106 <div class="menu">
 107   <a href="../../www/download.html">Download</a>
 108 </div>
 109 <div class="sep"></div>\r
 110 <div class="menu">
 111   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
 112 </div>
 113 <div class="sep"></div>\r
 114 <div class="menu">
 115   <a href="../../www/sitemap.html">Site Map</a>
 116 </div>
 117 <div  class="sub">
 118     <a href="../../www/links.html">Links</a>
 119 </div>
 120 <div class="sep"></div>\r
 121 <div  class="menu">
 122   <a href="../../www/sponsors.html">Sponsors:</a>
 123
 124 <div class="sponsbox">
 125 <div  class="sponsor">
 126    <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
 127 </div>
 128 <div  class="sponsor">
 129    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 130 </div>
 131 <div  class="sponsor">
 132   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
 133 </div>
 134 <div  class="sponsor">
 135   <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
 136 </div>
 137 <div  class="sponsor">
 138   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 139 </div>
 140 <div  class="sponsor">
 141   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201002010120 Buchhorn -->
 142 </div>
 143 </div>
 144 </div>
 145 \r
 146 \r
 147 </div>\r
 148 \r
 149 <div class="main">\r
 150 \r
 151 <p class="navigation-index">[<a href="#SetImageProgressMonitor">SetImageProgressMonitor</a> &bull; <a href="#SetImageInfoProgressMonitor">SetImageInfoProgressMonitor</a>]</p>
 152
 153 <h2><a href="http://www.imagemagick.org/api/MagickCore/monitor
 154 _8c.html" target="source" name="SetImageProgressMonitor">SetImageProgressMonitor</a></h2>
 155 <div class="doc-section">
 156
 157 <p>SetImageProgressMonitor() sets the image progress monitor to the specified method and returns the previous progress monitor if any.  The progress monitor method looks like this:</p>
 158
 159 <pre class="text">
 160       MagickBooleanType MagickProgressMonitor(const char *text,
 161   const MagickOffsetType offset,const MagickSizeType extent,
 162   void *client_data)
 163 </pre>
 164
 165 <p>If the progress monitor returns MagickFalse, the current operation is interrupted.</p></ol>
 166
 167 <p>The format of the SetImageProgressMonitor method is:</p>
 168
 169 <pre class="code">
 170   MagickProgressMonitor SetImageProgressMonitor(Image *image,
 171     const MagickProgressMonitor progress_monitor,void *client_data)
 172 </pre>
 173
 174 <p>A description of each parameter follows:</p></ol>
 175
 176 <h5>image</h5>
 177 <ol><p>the image.</p></ol>
 178
 179 <h5>progress_monitor</h5>
 180 <ol><p>Specifies a pointer to a method to monitor progress of an image operation.</p></ol>
 181
 182 <h5>client_data</h5>
 183 <ol><p>Specifies a pointer to any client data.</p></ol>
 184
 185  </div>
 186 <h2><a href="http://www.imagemagick.org/api/MagickCore/monitor
 187 _8c.html" target="source" name="SetImageInfoProgressMonitor">SetImageInfoProgressMonitor</a></h2>
 188 <div class="doc-section">
 189
 190 <p>SetImageInfoProgressMonitor() sets the image_info progress monitor to the specified method and returns the previous progress monitor if any.  The progress monitor method looks like this:</p>
 191
 192 <pre class="text">
 193       MagickBooleanType MagickProgressMonitor(const char *text,
 194   const MagickOffsetType offset,const MagickSizeType extent,
 195   void *client_data)
 196 </pre>
 197
 198 <p>If the progress monitor returns MagickFalse, the current operation is interrupted.</p></ol>
 199
 200 <p>The format of the SetImageInfoProgressMonitor method is:</p>
 201
 202 <pre class="code">
 203   MagickProgressMonitor SetImageInfoProgressMonitor(ImageInfo *image_info,
 204     const MagickProgressMonitor progress_monitor,void *client_data)
 205 </pre>
 206
 207 <p>A description of each parameter follows:</p></ol>
 208
 209 <h5>image_info</h5>
 210 <ol><p>the image info.</p></ol>
 211
 212 <h5>progress_monitor</h5>
 213 <ol><p>Specifies a pointer to a method to monitor progress of an image operation.</p></ol>
 214
 215 <h5>client_data</h5>
 216 <ol><p>Specifies a pointer to any client data.</p></ol>
 217
 218  </div>
 219 \r
 220 </div>\r
 221 \r
 222 <div id="linkbar">\r
 223  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 224     <span id="linkbar-center">\r
 225       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 226       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
 227     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 228     </span>\r
 229     <span id="linkbar-east">&nbsp;</span>\r
 230   </div>\r
 231   <div class="footer">\r
 232     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
 233     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 234   </div>\r
 235   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 236 </body>\r
 237 </html>\r