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

   1 <!DOCTYPE html>
   2 <html lang="en">
   3 <head>
   4     <title>ImageMagick: MagickCore, C API for ImageMagick: Monitor the Progress of an Image Operation</title>
   5   <meta http-equiv="content-type" content="text/html; charset=utf-8">
   6   <meta name="application-name" content="ImageMagick">
   7   <meta name="description" content="ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.">
   8   <meta name="application-url" content="http://www.imagemagick.org">
   9   <meta name="generator" content="PHP">
  10   <meta name="keywords" content="magickcore, c, api, for, imagemagick:, monitor, the, progress, of, an, image, operation, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert">
  11   <meta name="rating" content="GENERAL">
  12   <meta name="robots" content="INDEX, FOLLOW">
  13   <meta name="generator" content="ImageMagick Studio LLC">
  14   <meta name="author" content="ImageMagick Studio LLC">
  15   <meta name="revisit-after" content="2 DAYS">
  16   <meta name="resource-type" content="document">
  17   <meta name="copyright" content="Copyright (c) 1999-2015 ImageMagick Studio LLC">
  18   <meta name="distribution" content="Global">
  19   <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1">
  20   <link href="../images/wand.ico" type="images/x-icon" rel="shortcut icon">
  21   <link href="../images/wand.png" type="images/png" rel="icon">
  22   <link href="../css/magick.html" type="text/css" rel="stylesheet">
  23 </head>
  24 <body>
  25 <div class="main">
  26 <div class="magick-masthead">
  27   <div class="container">
  28     <script async src="http://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>
  29     <ins class="adsbygoogle" style="display:block" data-ad-client="ca-pub-3129977114552745" data-ad-slot="6345125851" data-ad-format="auto"></ins>
  30     <script>
  31     (adsbygoogle = window.adsbygoogle || []).push({});
  32     </script>
  33     <nav class="magick-nav">
  34       <a class="magick-nav-item " href="../index.html">Home</a>
  35       <a class="magick-nav-item " href="../binary-releases.html">Download</a>
  36       <a class="magick-nav-item " href="../command-line-tools.html">Tools</a>
  37       <a class="magick-nav-item " href="../command-line-options.html">Options</a>
  38       <a class="magick-nav-item " href="../resources.html">Resources</a>
  39       <a class="magick-nav-item " href="api.html">Develop</a>
  40       <a class="magick-nav-item " href="http://nextgen.imagemagick.org/script/search.php">Search</a>
  41       <a class="magick-nav-item pull-right" href="http://www.imagemagick.org/discourse-server/">Community</a>
  42     </nav>
  43   </div>
  44 </div>
  45 <div class="container">
  46 <div class="magick-header">
  47 <p class="text-center"><a href="monitor.html#SetImageProgressMonitor">SetImageProgressMonitor</a> • <a href="monitor.html#SetImageInfoProgressMonitor">SetImageInfoProgressMonitor</a></p>
  48
  49 <h2><a href="http://nextgen.imagemagick.org/api/MagickCore/monitor_8c.html" id="SetImageProgressMonitor">SetImageProgressMonitor</a></h2>
  50
  51 <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>
  52
  53 <pre class="text">
  54     MagickBooleanType MagickProgressMonitor(const char *text,
  55 const MagickOffsetType offset,const MagickSizeType extent,
  56 void *client_data)
  57 </pre>
  58
  59 <p>If the progress monitor returns MagickFalse, the current operation is interrupted.</p>
  60
  61 <p>The format of the SetImageProgressMonitor method is:</p>
  62
  63 <pre class="text">
  64 MagickProgressMonitor SetImageProgressMonitor(Image *image,
  65   const MagickProgressMonitor progress_monitor,void *client_data)
  66 </pre>
  67
  68 <p>A description of each parameter follows:</p>
  69
  70 <dd>
  71 </dd>
  72
  73 <dd> </dd>
  74 <dl class="dl-horizontal">
  75 <dt>image</dt>
  76 <dd>the image. </dd>
  77
  78 <dd> </dd>
  79 <dt>progress_monitor</dt>
  80 <dd>Specifies a pointer to a method to monitor progress of an image operation. </dd>
  81
  82 <dd> </dd>
  83 <dt>client_data</dt>
  84 <dd>Specifies a pointer to any client data. </dd>
  85
  86 <dd>  </dd>
  87 </dl>
  88 <h2><a href="http://nextgen.imagemagick.org/api/MagickCore/monitor_8c.html" id="SetImageInfoProgressMonitor">SetImageInfoProgressMonitor</a></h2>
  89
  90 <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>
  91
  92 <pre class="text">
  93     MagickBooleanType MagickProgressMonitor(const char *text,
  94 const MagickOffsetType offset,const MagickSizeType extent,
  95 void *client_data)
  96 </pre>
  97
  98 <p>If the progress monitor returns MagickFalse, the current operation is interrupted.</p>
  99
 100 <p>The format of the SetImageInfoProgressMonitor method is:</p>
 101
 102 <pre class="text">
 103 MagickProgressMonitor SetImageInfoProgressMonitor(ImageInfo *image_info,
 104   const MagickProgressMonitor progress_monitor,void *client_data)
 105 </pre>
 106
 107 <p>A description of each parameter follows:</p>
 108
 109 <dd>
 110 </dd>
 111
 112 <dd> </dd>
 113 <dl class="dl-horizontal">
 114 <dt>image_info</dt>
 115 <dd>the image info. </dd>
 116
 117 <dd> </dd>
 118 <dt>progress_monitor</dt>
 119 <dd>Specifies a pointer to a method to monitor progress of an image operation. </dd>
 120
 121 <dd> </dd>
 122 <dt>client_data</dt>
 123 <dd>Specifies a pointer to any client data. </dd>
 124
 125 <dd>  </dd>
 126 </dl>
 127 </div>
 128   <footer class="magick-footer">
 129     <p><a href="../support.html">Donate</a> •
 130      <a href="../sitemap.html">Sitemap</a> •
 131     <a href="../links.html">Related</a> •
 132     <a href="../architecture.html">Architecture</a>
 133 </p>
 134     <p><a href="monitor.html#">Back to top</a> •
 135     <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
 136     <a href="http://nextgen.imagemagick.org/script/contact.php">Contact Us</a></p>
 137     <p><small>©  1999-2015 ImageMagick Studio LLC</small></p>
 138   </footer>
 139 </div><!-- /.container -->
 140
 141   <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
 142   <script src="http://nextgen.imagemagick.org/js/magick.html"></script>
 143 </div>
 144 </body>
 145 </html>