granicus.if.org Git - imagemagick/blob - www/api/resource.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 http-equiv="Content-Type" value="application/xhtml+xml" />\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="screen,projection"><!--\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 or Limit Resource Consumption</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, or, limit, resource, consumption, 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 href="../../index.html">About ImageMagick</a>
  49 </div>
  50 <div class="sep"></div>\r
  51 <div class="menu">
  52   <a href="../../www/command-line-tools.html">Command-line Tools</a>
  53 </div>
  54 <div class="sub">
  55     <a href="../../www/command-line-processing.html">Processing</a>
  56 </div>
  57 <div class="sub">
  58     <a href="../../www/command-line-options.html">Options</a>
  59 </div>
  60 <div class="sub">
  61     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  62 </div>
  63 <div class="menu">
  64   <a href="../../www/api.html">Program Interfaces</a>
  65 </div>
  66 <div class="sub">
  67     <a href="../../www/magick-wand.html">MagickWand</a>
  68 </div>
  69 <div class="sub">
  70     <a href="../../www/magick-core.html">MagickCore</a>
  71 </div>
  72 <div class="sub">
  73     <a href="../../www/perl-magick.html">PerlMagick</a>
  74 </div>
  75 <div class="sub">
  76     <a href="../../Magick++/">Magick++</a>
  77 </div>
  78 <div class="menu">
  79   <a href="../../www/architecture.html">Architecture</a>
  80 </div>
  81 <div class="sep"></div>\r
  82 <div  class="menu">
  83    <a href="../../www/install-source.html">Install from Source</a>
  84 </div>
  85 <div class="sub">
  86     <a href="../../www/install-source.html#unix">Unix</a>
  87 </div>
  88 <div class="sub">
  89     <a href="../../www/install-source.html#windows">Windows</a>
  90  </div>
  91 <div class="menu">
  92   <a href="../../www/binary-releases.html">Binary Releases</a>
  93 </div>
  94 <div class="sub">
  95     <a href="../../www/binary-releases.html#unix">Unix</a>
  96 </div>
  97 <div class="sub">
  98     <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
  99 </div>
 100 <div class="sub">
 101     <a href="../../www/binary-releases.html#windows">Windows</a>
 102 </div>
 103 <div class="menu">
 104   <a href="../../www/resources.html">Resources</a>
 105 </div>
 106 <div class="sep"></div>\r
 107 <div class="menu">
 108   <a href="../../www/download.html">Download</a>
 109 </div>
 110 <div class="sep"></div>\r
 111 <div class="menu">
 112   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
 113 </div>
 114 <div class="sep"></div>\r
 115 <div class="menu">
 116   <a href="../../www/sitemap.html">Site Map</a>
 117 </div>
 118 <div  class="sub">
 119     <a href="../../www/links.html">Links</a>
 120 </div>
 121 <div class="sep"></div>\r
 122 <div  class="menu">
 123   <a href="../../www/sponsors.html">Sponsors:</a>
 124
 125 <div class="sponsbox">
 126 <div  class="sponsor">
 127    <a href="http://www.hygi.de">Reinigungsmittel</a><!-- 201002000400+ -->
 128 </div>
 129 <div  class="sponsor">
 130   <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
 131 </div>
 132 <div  class="sponsor">
 133   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201004010120 Buchhorn -->
 134 </div>
 135 <div  class="sponsor">
 136   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
 137 </div>
 138 <div  class="sponsor">
 139   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 140 </div>
 141 <div  class="sponsor">
 142    <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
 143 </div>
 144 <div  class="sponsor">
 145    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 146 </div>
 147 <div  class="sponsor">
 148   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 149 </div>
 150 </div>
 151 </div>
 152 \r
 153 \r
 154 </div>\r
 155 \r
 156 <div class="main">\r
 157 \r
 158 <p class="navigation-index">[<a href="#AcquireMagickResource">AcquireMagickResource</a> &bull; <a href="#AcquireUniqueFileResource">AcquireUniqueFileResource</a> &bull; <a href="#GetMagickResource">GetMagickResource</a> &bull; <a href="#GetMagickResource">GetMagickResource</a> &bull; <a href="#ListMagickResourceInfo">ListMagickResourceInfo</a> &bull; <a href="#RelinquishMagickResource">RelinquishMagickResource</a> &bull; <a href="#RelinquishUniqueFileResource">RelinquishUniqueFileResource</a> &bull; <a href="#SetMagickResourceLimit">SetMagickResourceLimit</a>]</p>
 159
 160 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 161 _8c.html" target="source" name="AcquireMagickResource">AcquireMagickResource</a></h2>
 162 <div class="doc-section">
 163
 164 <p>AcquireMagickResource() acquires resources of the specified type. MagickFalse is returned if the specified resource is exhausted otherwise MagickTrue.</p></ol>
 165
 166 <p>The format of the AcquireMagickResource() method is:</p>
 167
 168 <pre class="code">
 169   MagickBooleanType AcquireMagickResource(const ResourceType type,
 170     const MagickSizeType size)
 171 </pre>
 172
 173 <p>A description of each parameter follows:</p></ol>
 174
 175 <h5>type</h5>
 176 <ol><p>the type of resource.</p></ol>
 177
 178 <h5>size</h5>
 179 <ol><p>the number of bytes needed from for this resource.</p></ol>
 180
 181  </div>
 182 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 183 _8c.html" target="source" name="AcquireUniqueFileResource">AcquireUniqueFileResource</a></h2>
 184 <div class="doc-section">
 185
 186 <p>AcquireUniqueFileResource() returns a unique file name, and returns a file descriptor for the file open for reading and writing.</p></ol>
 187
 188 <p>The format of the AcquireUniqueFileResource() method is:</p>
 189
 190 <pre class="code">
 191   int AcquireUniqueFileResource(char *path)
 192 </pre>
 193
 194 <p>A description of each parameter follows:</p></ol>
 195
 196 <h5> path</h5>
 197 <ol><p>Specifies a pointer to an array of characters.  The unique path name is returned in this array.</p></ol>
 198
 199  </div>
 200 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 201 _8c.html" target="source" name="GetMagickResource">GetMagickResource</a></h2>
 202 <div class="doc-section">
 203
 204 <p>GetMagickResource() returns the specified resource.</p></ol>
 205
 206 <p>The format of the GetMagickResource() method is:</p>
 207
 208 <pre class="code">
 209   MagickSizeType GetMagickResource(const ResourceType type)
 210 </pre>
 211
 212 <p>A description of each parameter follows:</p></ol>
 213
 214 <h5>type</h5>
 215 <ol><p>the type of resource.</p></ol>
 216
 217  </div>
 218 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 219 _8c.html" target="source" name="GetMagickResource">GetMagickResource</a></h2>
 220 <div class="doc-section">
 221
 222 <p>GetMagickResource() returns the specified resource limit.</p></ol>
 223
 224 <p>The format of the GetMagickResourceLimit() method is:</p>
 225
 226 <pre class="code">
 227   unsigned long GetMagickResourceLimit(const ResourceType type)
 228 </pre>
 229
 230 <p>A description of each parameter follows:</p></ol>
 231
 232 <h5>type</h5>
 233 <ol><p>the type of resource.</p></ol>
 234
 235  </div>
 236 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 237 _8c.html" target="source" name="ListMagickResourceInfo">ListMagickResourceInfo</a></h2>
 238 <div class="doc-section">
 239
 240 <p>ListMagickResourceInfo() lists the resource info to a file.</p></ol>
 241
 242 <p>The format of the ListMagickResourceInfo method is:</p>
 243
 244 <pre class="code">
 245   MagickBooleanType ListMagickResourceInfo(FILE *file,
 246     ExceptionInfo *exception)
 247 </pre>
 248
 249 <p>A description of each parameter follows.</p></ol>
 250
 251 <h5>file</h5>
 252 <ol><p>An pointer to a FILE.</p></ol>
 253
 254 <h5>exception</h5>
 255 <ol><p>return any errors or warnings in this structure.</p></ol>
 256
 257  </div>
 258 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 259 _8c.html" target="source" name="RelinquishMagickResource">RelinquishMagickResource</a></h2>
 260 <div class="doc-section">
 261
 262 <p>RelinquishMagickResource() relinquishes resources of the specified type.</p></ol>
 263
 264 <p>The format of the RelinquishMagickResource() method is:</p>
 265
 266 <pre class="code">
 267   void RelinquishMagickResource(const ResourceType type,
 268     const MagickSizeType size)
 269 </pre>
 270
 271 <p>A description of each parameter follows:</p></ol>
 272
 273 <h5>type</h5>
 274 <ol><p>the type of resource.</p></ol>
 275
 276 <h5>size</h5>
 277 <ol><p>the size of the resource.</p></ol>
 278
 279  </div>
 280 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 281 _8c.html" target="source" name="RelinquishUniqueFileResource">RelinquishUniqueFileResource</a></h2>
 282 <div class="doc-section">
 283
 284 <p>RelinquishUniqueFileResource() relinquishes a unique file resource.</p></ol>
 285
 286 <p>The format of the RelinquishUniqueFileResource() method is:</p>
 287
 288 <pre class="code">
 289   MagickBooleanType RelinquishUniqueFileResource(const char *path)
 290 </pre>
 291
 292 <p>A description of each parameter follows:</p></ol>
 293
 294 <h5>name</h5>
 295 <ol><p>the name of the temporary resource.</p></ol>
 296
 297  </div>
 298 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 299 _8c.html" target="source" name="SetMagickResourceLimit">SetMagickResourceLimit</a></h2>
 300 <div class="doc-section">
 301
 302 <p>SetMagickResourceLimit() sets the limit for a particular resource.</p></ol>
 303
 304 <p>The format of the SetMagickResourceLimit() method is:</p>
 305
 306 <pre class="code">
 307   MagickBooleanType SetMagickResourceLimit(const ResourceType type,
 308     const MagickSizeType limit)
 309 </pre>
 310
 311 <p>A description of each parameter follows:</p></ol>
 312
 313 <h5>type</h5>
 314 <ol><p>the type of resource.</p></ol>
 315
 316 <h5>limit</h5>
 317 <ol><p>the maximum limit for the resource.</p></ol>
 318
 319  </div>
 320 \r
 321 </div>\r
 322 \r
 323 <div id="linkbar">\r
 324  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 325     <span id="linkbar-center">\r
 326       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 327       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
 328     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 329     </span>\r
 330     <span id="linkbar-east">&nbsp;</span>\r
 331   </div>\r
 332   <div class="footer">\r
 333     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 334     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 335   </div>\r
 336   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 337 </body>\r
 338 </html>\r