1 2 3 4 5<!doctype html> 6<html lang="en"> 7<head> 8 <meta charset="utf-8" /> 9 <meta name="viewport" content="width=device-width, initial-scale=1" /> 10 <title>ImageMagick - MagickCore, C API: Monitor the Progress of an Image Operation</title> 11 <meta name="application-name" content="ImageMagick" /> 12 <meta name="description" content="Use ImageMagick® to create, edit, compose, and convert digital images. Resize an image, crop it, change its shades and colors, add captions, and more." /> 13 <meta name="application-url" content="https://imagemagick.org" /> 14 <meta name="generator" content="PHP" /> 15 <meta name="keywords" content="magickcore, c, api:, monitor, the, progress, of, an, image, operation, image processing software" /> 16 <meta name="rating" content="GENERAL" /> 17 <meta name="robots" content="INDEX, FOLLOW" /> 18 <meta name="generator" content="ImageMagick Studio LLC" /> 19 <meta name="author" content="ImageMagick Studio LLC" /> 20 <meta name="revisit-after" content="2 DAYS" /> 21 <meta name="resource-type" content="document" /> 22 <meta name="copyright" content="Copyright (c) 1999-2020 ImageMagick Studio LLC" /> 23 <meta name="distribution" content="Global" /> 24 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1" /> 25 <meta property='og:url' content='../../' /> 26 <meta property='og:title' content='ImageMagick' /> 27 <meta property='og:image' content='../../../images/logo.png' /> 28 <meta property='og:type' content='website' /> 29 <meta property='og:site_name' content='ImageMagick' /> 30 <meta property='og:description' content="Create, Edit, Compose, or Convert Digital Images" /> 31 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" /> 32 <link href="monitor.html" rel="canonical" /> 33 <link href="../../../images/wand.png" rel="icon" /> 34 <link href="../../../images/wand.ico" rel="shortcut icon" /> 35 <link href="../../assets/magick.css" rel="stylesheet" /> 36</head> 37<body> 38 <nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top"> 39 <div class="container-fluid"> 40 <a class="navbar-brand" href="../../"><img class="d-block" id="icon" alt="ImageMagick" width="32" height="32" src="../../../images/wand.ico"/></a> 41 <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#magick-navbars" aria-controls="magick-navbars" aria-expanded="false" aria-label="Toggle navigation"> 42 <span class="navbar-toggler-icon"></span> 43 </button> 44 45 <div class="collapse navbar-collapse" id="magick-navbars"> 46 <ul class="navbar-nav me-auto mb-2 mb-md-0"> 47 <li class="nav-item"> 48 <a class="nav-link " href="../../www/index.html">Home</a> 49 </li> 50 <li class="nav-item"> 51 <a class="nav-link " href="../../www/download.html">Download</a> 52 </li> 53 <li class="nav-item"> 54 <a class="nav-link " href="../../www/command-line-tools.html">Tools</a> 55 </li> 56 <li class="nav-item"> 57 <a class="nav-link " href="../../www/command-line-processing.html">CLI</a> 58 </li> 59 <li class="nav-item"> 60 <a class="nav-link " href="../../www/develop.html">Develop</a> 61 </li> 62 <li class="nav-item"> 63 <a class="nav-link" target="_blank" href="https://github.com/ImageMagick/ImageMagick/discussions">Community</a> 64 </li> 65 <li class="nav-item"> 66 <iframe src="https://github.com/sponsors/ImageMagick/button" title="Sponsor ImageMagick" height="35" width="107" style="border: 0;"></iframe> 67 </li> 68 </ul> 69 <form class="d-flex form-inline" action="https://imagemagick.org/script/search.php"> 70 <input class="form-control me-2" type="text" name="q" placeholder="Search" aria-label="Search"> 71 <button class="btn btn-outline-success" type="submit" name="sa">Search</button> 72 </form> 73 </div> 74 </div> 75 </nav> 76 77 <div class="container"> 78 <script async="async" src="https://localhost/pagead/js/adsbygoogle.js"></script> 79 <ins class="adsbygoogle" 80 style="display:block" 81 data-ad-client="ca-pub-3129977114552745" 82 data-ad-slot="6345125851" 83 data-full-width-responsive="true" 84 data-ad-format="horizontal"></ins> 85 <script> 86 (adsbygoogle = window.adsbygoogle || []).push({}); 87 </script> 88 89 </div> 90 91 <main class="container"> 92 <div class="magick-template"> 93<div class="magick-header"> 94<p class="text-center"><a href="monitor.html#SetImageProgress">SetImageProgress</a> • <a href="monitor.html#SetImageProgressMonitor">SetImageProgressMonitor</a> • <a href="monitor.html#SetImageInfoProgressMonitor">SetImageInfoProgressMonitor</a></p> 95 96<h2><a href="../../api/MagickCore/monitor_8c.html" id="SetImageProgress">SetImageProgress</a></h2> 97 98<p>SetImageProgress() returns the progress of an image processing operation.</p> 99 100<p>The format of the SetImageProgress method is:</p> 101 102<pre class="text"> 103 MagickBooleanType SetImageProgress(const char *text, 104const MagickOffsetType offset,const MagickSizeType extent) 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</dt> 115<dd>the image. </dd> 116 117<dd> </dd> 118<dt>text</dt> 119<dd>description of the image processing operation. </dd> 120 121<dd> </dd> 122<dt>offset</dt> 123<dd>the offset relative to the extent parameter. </dd> 124 125<dd> </dd> 126<dt>extent</dt> 127<dd>the extent of the progress. </dd> 128 129<dd> </dd> 130</dl> 131<h2><a href="../../api/MagickCore/monitor_8c.html" id="SetImageProgressMonitor">SetImageProgressMonitor</a></h2> 132 133<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> 134 135<pre class="text"> 136 MagickBooleanType MagickProgressMonitor(const char *text, 137const MagickOffsetType offset,const MagickSizeType extent, 138void *client_data) 139</pre> 140 141<p>If the progress monitor returns MagickFalse, the current operation is interrupted.</p> 142 143<p>The format of the SetImageProgressMonitor method is:</p> 144 145<pre class="text"> 146MagickProgressMonitor SetImageProgressMonitor(Image *image, 147 const MagickProgressMonitor progress_monitor,void *client_data) 148</pre> 149 150<p>A description of each parameter follows:</p> 151 152<dd> 153</dd> 154 155<dd> </dd> 156<dl class="dl-horizontal"> 157<dt>image</dt> 158<dd>the image. </dd> 159 160<dd> </dd> 161<dt>progress_monitor</dt> 162<dd>Specifies a pointer to a method to monitor progress of an image operation. </dd> 163 164<dd> </dd> 165<dt>client_data</dt> 166<dd>Specifies a pointer to any client data. </dd> 167 168<dd> </dd> 169</dl> 170<h2><a href="../../api/MagickCore/monitor_8c.html" id="SetImageInfoProgressMonitor">SetImageInfoProgressMonitor</a></h2> 171 172<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> 173 174<pre class="text"> 175 MagickBooleanType MagickProgressMonitor(const char *text, 176const MagickOffsetType offset,const MagickSizeType extent, 177void *client_data) 178</pre> 179 180<p>If the progress monitor returns MagickFalse, the current operation is interrupted.</p> 181 182<p>The format of the SetImageInfoProgressMonitor method is:</p> 183 184<pre class="text"> 185MagickProgressMonitor SetImageInfoProgressMonitor(ImageInfo *image_info, 186 const MagickProgressMonitor progress_monitor,void *client_data) 187</pre> 188 189<p>A description of each parameter follows:</p> 190 191<dd> 192</dd> 193 194<dd> </dd> 195<dl class="dl-horizontal"> 196<dt>image_info</dt> 197<dd>the image info. </dd> 198 199<dd> </dd> 200<dt>progress_monitor</dt> 201<dd>Specifies a pointer to a method to monitor progress of an image operation. </dd> 202 203<dd> </dd> 204<dt>client_data</dt> 205<dd>Specifies a pointer to any client data. </dd> 206 207<dd> </dd> 208</dl> 209</div> 210 </div> 211 </main><!-- /.container --> 212 <footer class="magick-footer"> 213 <div class="container-fluid"> 214 <a href="../../www/security-policy.html">Security</a> • 215 <a href="../../www/news.html">News</a> 216 217 <a href="monitor.html#"><img class="d-inline" id="wand" alt="And Now a Touch of Magick" width="16" height="16" src="../../../images/wand.ico"/></a> 218 219 <a href="../../www/links.html">Related</a> • 220 <a href="../../www/sitemap.html">Sitemap</a> 221 <br/> 222 <a href="../../www/support.html">Sponsor</a> • 223 <a href="../../www/cite.html">Cite</a> • 224 <a href="http://pgp.mit.edu/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> • 225 <a href="../../www/contact.html">Contact Us</a> 226 <br/> 227 <a href="https://github.com/imagemagick/imagemagick" target="_blank" rel="noopener" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 512 499.36" width="2%" height="2%" role="img" focusable="false"><title>GitHub</title><path fill="currentColor" fill-rule="evenodd" d="M256 0C114.64 0 0 114.61 0 256c0 113.09 73.34 209 175.08 242.9 12.8 2.35 17.47-5.56 17.47-12.34 0-6.08-.22-22.18-.35-43.54-71.2 15.49-86.2-34.34-86.2-34.34-11.64-29.57-28.42-37.45-28.42-37.45-23.27-15.84 1.73-15.55 1.73-15.55 25.69 1.81 39.21 26.38 39.21 26.38 22.84 39.12 59.92 27.82 74.5 21.27 2.33-16.54 8.94-27.82 16.25-34.22-56.84-6.43-116.6-28.43-116.6-126.49 0-27.95 10-50.8 26.35-68.69-2.63-6.48-11.42-32.5 2.51-67.75 0 0 21.49-6.88 70.4 26.24a242.65 242.65 0 0 1 128.18 0c48.87-33.13 70.33-26.24 70.33-26.24 14 35.25 5.18 61.27 2.55 67.75 16.41 17.9 26.31 40.75 26.31 68.69 0 98.35-59.85 120-116.88 126.32 9.19 7.9 17.38 23.53 17.38 47.41 0 34.22-.31 61.83-.31 70.23 0 6.85 4.61 14.81 17.6 12.31C438.72 464.97 512 369.08 512 256.02 512 114.62 397.37 0 256 0z"/></svg></a> • 228 <a href="https://twitter.com/imagemagick" target="_blank" rel="noopener" aria-label="Twitter"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 512 416.32" width="2%" height="2%" role="img" focusable="false"><title>Twitter</title><path fill="currentColor" d="M160.83 416.32c193.2 0 298.92-160.22 298.92-298.92 0-4.51 0-9-.2-13.52A214 214 0 0 0 512 49.38a212.93 212.93 0 0 1-60.44 16.6 105.7 105.7 0 0 0 46.3-58.19 209 209 0 0 1-66.79 25.37 105.09 105.09 0 0 0-181.73 71.91 116.12 116.12 0 0 0 2.66 24c-87.28-4.3-164.73-46.3-216.56-109.82A105.48 105.48 0 0 0 68 159.6a106.27 106.27 0 0 1-47.53-13.11v1.43a105.28 105.28 0 0 0 84.21 103.06 105.67 105.67 0 0 1-47.33 1.84 105.06 105.06 0 0 0 98.14 72.94A210.72 210.72 0 0 1 25 370.84a202.17 202.17 0 0 1-25-1.43 298.85 298.85 0 0 0 160.83 46.92"/></svg></a> 229 <br/> 230 <small>© 1999-2021 ImageMagick Studio LLC</small> 231 </div> 232 </footer> 233 234 <!-- Javascript assets --> 235 <script src="../../assets/magick.js" ></script> 236 </body> 237</html> 238
