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 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 or Limit Resource Consumption</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, or, limit, resource, consumption, 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.online-kredit-index.de">Kredit</a><!-- 201004010120 Buchhorn -->
 127 </div>
 128 <div  class="sponsor">
 129   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
 130 </div>
 131 <div  class="sponsor">
 132   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 133 </div>
 134 <div  class="sponsor">
 135    <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
 136 </div>
 137 <div  class="sponsor">
 138    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 139 </div>
 140 <div  class="sponsor">
 141   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 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="#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>
 152
 153 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 154 _8c.html" target="source" name="AcquireMagickResource">AcquireMagickResource</a></h2>
 155 <div class="doc-section">
 156
 157 <p>AcquireMagickResource() acquires resources of the specified type. MagickFalse is returned if the specified resource is exhausted otherwise MagickTrue.</p></ol>
 158
 159 <p>The format of the AcquireMagickResource() method is:</p>
 160
 161 <pre class="code">
 162   MagickBooleanType AcquireMagickResource(const ResourceType type,
 163     const MagickSizeType size)
 164 </pre>
 165
 166 <p>A description of each parameter follows:</p></ol>
 167
 168 <h5>type</h5>
 169 <ol><p>the type of resource.</p></ol>
 170
 171 <h5>size</h5>
 172 <ol><p>the number of bytes needed from for this resource.</p></ol>
 173
 174  </div>
 175 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 176 _8c.html" target="source" name="AcquireUniqueFileResource">AcquireUniqueFileResource</a></h2>
 177 <div class="doc-section">
 178
 179 <p>AcquireUniqueFileResource() returns a unique file name, and returns a file descriptor for the file open for reading and writing.</p></ol>
 180
 181 <p>The format of the AcquireUniqueFileResource() method is:</p>
 182
 183 <pre class="code">
 184   int AcquireUniqueFileResource(char *path)
 185 </pre>
 186
 187 <p>A description of each parameter follows:</p></ol>
 188
 189 <h5> path</h5>
 190 <ol><p>Specifies a pointer to an array of characters.  The unique path name is returned in this array.</p></ol>
 191
 192  </div>
 193 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 194 _8c.html" target="source" name="GetMagickResource">GetMagickResource</a></h2>
 195 <div class="doc-section">
 196
 197 <p>GetMagickResource() returns the specified resource.</p></ol>
 198
 199 <p>The format of the GetMagickResource() method is:</p>
 200
 201 <pre class="code">
 202   MagickSizeType GetMagickResource(const ResourceType type)
 203 </pre>
 204
 205 <p>A description of each parameter follows:</p></ol>
 206
 207 <h5>type</h5>
 208 <ol><p>the type of resource.</p></ol>
 209
 210  </div>
 211 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 212 _8c.html" target="source" name="GetMagickResource">GetMagickResource</a></h2>
 213 <div class="doc-section">
 214
 215 <p>GetMagickResource() returns the specified resource limit.</p></ol>
 216
 217 <p>The format of the GetMagickResourceLimit() method is:</p>
 218
 219 <pre class="code">
 220   unsigned long GetMagickResourceLimit(const ResourceType type)
 221 </pre>
 222
 223 <p>A description of each parameter follows:</p></ol>
 224
 225 <h5>type</h5>
 226 <ol><p>the type of resource.</p></ol>
 227
 228  </div>
 229 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 230 _8c.html" target="source" name="ListMagickResourceInfo">ListMagickResourceInfo</a></h2>
 231 <div class="doc-section">
 232
 233 <p>ListMagickResourceInfo() lists the resource info to a file.</p></ol>
 234
 235 <p>The format of the ListMagickResourceInfo method is:</p>
 236
 237 <pre class="code">
 238   MagickBooleanType ListMagickResourceInfo(FILE *file,
 239     ExceptionInfo *exception)
 240 </pre>
 241
 242 <p>A description of each parameter follows.</p></ol>
 243
 244 <h5>file</h5>
 245 <ol><p>An pointer to a FILE.</p></ol>
 246
 247 <h5>exception</h5>
 248 <ol><p>return any errors or warnings in this structure.</p></ol>
 249
 250  </div>
 251 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 252 _8c.html" target="source" name="RelinquishMagickResource">RelinquishMagickResource</a></h2>
 253 <div class="doc-section">
 254
 255 <p>RelinquishMagickResource() relinquishes resources of the specified type.</p></ol>
 256
 257 <p>The format of the RelinquishMagickResource() method is:</p>
 258
 259 <pre class="code">
 260   void RelinquishMagickResource(const ResourceType type,
 261     const MagickSizeType size)
 262 </pre>
 263
 264 <p>A description of each parameter follows:</p></ol>
 265
 266 <h5>type</h5>
 267 <ol><p>the type of resource.</p></ol>
 268
 269 <h5>size</h5>
 270 <ol><p>the size of the resource.</p></ol>
 271
 272  </div>
 273 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 274 _8c.html" target="source" name="RelinquishUniqueFileResource">RelinquishUniqueFileResource</a></h2>
 275 <div class="doc-section">
 276
 277 <p>RelinquishUniqueFileResource() relinquishes a unique file resource.</p></ol>
 278
 279 <p>The format of the RelinquishUniqueFileResource() method is:</p>
 280
 281 <pre class="code">
 282   MagickBooleanType RelinquishUniqueFileResource(const char *path)
 283 </pre>
 284
 285 <p>A description of each parameter follows:</p></ol>
 286
 287 <h5>name</h5>
 288 <ol><p>the name of the temporary resource.</p></ol>
 289
 290  </div>
 291 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 292 _8c.html" target="source" name="SetMagickResourceLimit">SetMagickResourceLimit</a></h2>
 293 <div class="doc-section">
 294
 295 <p>SetMagickResourceLimit() sets the limit for a particular resource.</p></ol>
 296
 297 <p>The format of the SetMagickResourceLimit() method is:</p>
 298
 299 <pre class="code">
 300   MagickBooleanType SetMagickResourceLimit(const ResourceType type,
 301     const MagickSizeType limit)
 302 </pre>
 303
 304 <p>A description of each parameter follows:</p></ol>
 305
 306 <h5>type</h5>
 307 <ol><p>the type of resource.</p></ol>
 308
 309 <h5>limit</h5>
 310 <ol><p>the maximum limit for the resource.</p></ol>
 311
 312  </div>
 313 \r
 314 </div>\r
 315 \r
 316 <div id="linkbar">\r
 317  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 318     <span id="linkbar-center">\r
 319       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 320       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
 321     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 322     </span>\r
 323     <span id="linkbar-east">&nbsp;</span>\r
 324   </div>\r
 325   <div class="footer">\r
 326     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
 327     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 328   </div>\r
 329   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 330 </body>\r
 331 </html>\r