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" dir="ltr">\r
   4 <head>\r
   5   <meta http-equiv="content-type" content="text/html; charset=utf-8"/>\r
   6   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
   7   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   8   <style type="text/css" media="all">\r
   9     @import url("../../www/magick.css");\r
  10   </style>\r
  11   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  12   <title>ImageMagick: MagickCore, C API for ImageMagick: Monitor the Progress of an Image Operation</title>
  13   <meta http-equiv="Content-Language" content="en-US"/>
  14   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  15   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  16   <meta name="Generator" content="PHP"/>
  17   <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"/>
  18   <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."/>
  19   <meta name="Rating" content="GENERAL"/>
  20   <meta name="Robots" content="INDEX, FOLLOW"/>
  21   <meta name="Generator" content="ImageMagick Studio LLC"/>
  22   <meta name="Author" content="ImageMagick Studio LLC"/>
  23   <meta name="Revisit-after" content="2 DAYS"/>
  24   <meta name="Resource-type" content="document"/>
  25   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
  26   <meta name="Distribution" content="Global"/>
  27 </head>\r
  28 \r
  29 <body id="www-imagemagick-org">\r
  30 <div class="titlebar">\r
  31 <a href="../../index.html">\r
  32   <img src="../../images/script.png" alt="[ImageMagick]"\r
  33   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  34 <a href="http://www.networkredux.com">\r
  35   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  36   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  37 <a href="http://www.imagemagick.org/discourse-server/">\r
  38   <img src="../../images/logo.jpg" alt=""\r
  39   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  40 <a href="../../index.html">\r
  41   <img src="../../images/sprite.jpg" alt=""\r
  42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  43 </div>\r
  44 \r
  45 <div class="eastbar">\r
  46 \r
  47 <div class="menu">
  48   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  49 </div>
  50 <div class="sep"></div>\r
  51 <div class="menu">
  52   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  53 </div>
  54 <div class="sub">
  55     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  56 </div>
  57 <div class="sub">
  58     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  59 </div>
  60 <div class="sub">
  61     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  62 </div>
  63 <div class="menu">
  64   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
  65 </div>
  66 <div class="sub">
  67     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
  68 </div>
  69 <div class="sub">
  70     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
  71 </div>
  72 <div class="sub">
  73     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
  74 </div>
  75 <div class="sub">
  76     <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
  77 </div>
  78 <div class="menu">
  79   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
  80 </div>
  81 <div class="sep"></div>\r
  82 <div  class="menu">
  83    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
  84 </div>
  85 <div class="sub">
  86     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
  87 </div>
  88 <div class="sub">
  89     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
  90  </div>
  91 <div class="menu">
  92   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  93 </div>
  94 <div class="sub">
  95     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  96 </div>
  97 <div class="sub">
  98     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  99 </div>
 100 <div class="sub">
 101     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
 102 </div>
 103 <div class="menu">
 104   <a title="Resources" href="../../www/resources.html">Resources</a>
 105 </div>
 106 <div class="sep"></div>\r
 107 <div class="menu">
 108   <a title="Download" href="../../www/download.html">Download</a>
 109 </div>
 110 <div class="sep"></div>\r
 111 <div class="menu">
 112   <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
 113 </div>
 114 <div class="sep"></div>\r
 115 <div class="menu">
 116   <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
 117 </div>
 118 <div  class="sub">
 119     <a title="Site Map: Links"href="../../www/links.html">Links</a>
 120 </div>
 121 <div class="sep"></div>\r
 122 <div  class="menu">
 123   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 124
 125 <div class="sponsbox">
 126 <div  class="sponsor">
 127   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 128 </div>
 129 <div  class="sponsor">
 130   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 131 </div>
 132 <div  class="sponsor">
 133   <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
 134 </div>
 135 <div  class="sponsor">
 136   <a title="Sponsor: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
 137 </div>
 138 <div  class="sponsor">
 139   <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 140 </div>
 141 <div  class="sponsor">
 142    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 143 </div>
 144 <div  class="sponsor">
 145    <a title="Sponsor: Online-Magazin" href="http://www.unkostenbeitrag.de/" title="Online-Magazin">Online-Magazin</a><!-- 20101101000200 -->
 146 </div>
 147 </div>
 148 </div>
 149 \r
 150 \r
 151 </div>\r
 152 \r
 153 <div class="main">\r
 154 \r
 155 <p class="navigation-index">[<a href="#SetImageProgressMonitor">SetImageProgressMonitor</a> &bull; <a href="#SetImageInfoProgressMonitor">SetImageInfoProgressMonitor</a>]</p>
 156
 157 <h2><a href="http://www.imagemagick.org/api/MagickCore/monitor
 158 _8c.html" target="source" name="SetImageProgressMonitor">SetImageProgressMonitor</a></h2>
 159 <div class="doc-section">
 160
 161 <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>
 162
 163 <pre class="text">
 164       MagickBooleanType MagickProgressMonitor(const char *text,
 165   const MagickOffsetType offset,const MagickSizeType extent,
 166   void *client_data)
 167 </pre>
 168
 169 <p>If the progress monitor returns MagickFalse, the current operation is interrupted.</p></ol>
 170
 171 <p>The format of the SetImageProgressMonitor method is:</p>
 172
 173 <pre class="code">
 174   MagickProgressMonitor SetImageProgressMonitor(Image *image,
 175     const MagickProgressMonitor progress_monitor,void *client_data)
 176 </pre>
 177
 178 <p>A description of each parameter follows:</p></ol>
 179
 180 <h5>image</h5>
 181 <ol><p>the image.</p></ol>
 182
 183 <h5>progress_monitor</h5>
 184 <ol><p>Specifies a pointer to a method to monitor progress of an image operation.</p></ol>
 185
 186 <h5>client_data</h5>
 187 <ol><p>Specifies a pointer to any client data.</p></ol>
 188
 189  </div>
 190 <h2><a href="http://www.imagemagick.org/api/MagickCore/monitor
 191 _8c.html" target="source" name="SetImageInfoProgressMonitor">SetImageInfoProgressMonitor</a></h2>
 192 <div class="doc-section">
 193
 194 <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>
 195
 196 <pre class="text">
 197       MagickBooleanType MagickProgressMonitor(const char *text,
 198   const MagickOffsetType offset,const MagickSizeType extent,
 199   void *client_data)
 200 </pre>
 201
 202 <p>If the progress monitor returns MagickFalse, the current operation is interrupted.</p></ol>
 203
 204 <p>The format of the SetImageInfoProgressMonitor method is:</p>
 205
 206 <pre class="code">
 207   MagickProgressMonitor SetImageInfoProgressMonitor(ImageInfo *image_info,
 208     const MagickProgressMonitor progress_monitor,void *client_data)
 209 </pre>
 210
 211 <p>A description of each parameter follows:</p></ol>
 212
 213 <h5>image_info</h5>
 214 <ol><p>the image info.</p></ol>
 215
 216 <h5>progress_monitor</h5>
 217 <ol><p>Specifies a pointer to a method to monitor progress of an image operation.</p></ol>
 218
 219 <h5>client_data</h5>
 220 <ol><p>Specifies a pointer to any client data.</p></ol>
 221
 222  </div>
 223 \r
 224 </div>\r
 225 \r
 226 <div id="linkbar">\r
 227  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 228     <span id="linkbar-center">\r
 229       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 230     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 231     </span>\r
 232     <span id="linkbar-east">&nbsp;</span>\r
 233   </div>\r
 234   <div class="footer">\r
 235     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 236     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 237   </div>\r
 238   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 239 </body>\r
 240 </html>\r