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" 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 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 title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  49 </div>
  50 <div class="sep"></div>\r
  51 <div class="menu">
  52   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  53 </div>
  54 <div class="sub">
  55     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  56 </div>
  57 <div class="sub">
  58     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  59 </div>
  60 <div class="sub">
  61     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
  62 </div>
  63 <div class="sep"></div>\r
  64 <div class="menu">
  65   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  66 </div>
  67 <div class="sub">
  68     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  69 </div>
  70 <div class="sub">
  71     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  72 </div>
  73 <div class="sub">
  74     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  75 </div>
  76 <div class="menu">
  77   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
  78 </div>
  79 <div class="sub">
  80     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
  81 </div>
  82 <div class="sub">
  83     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
  84 </div>
  85 <div class="sub">
  86     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
  87 </div>
  88 <div class="sub">
  89     <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
  90 </div>
  91 <div class="sep"></div>\r
  92 <div  class="menu">
  93    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
  94 </div>
  95 <div class="sub">
  96     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
  97 </div>
  98 <div class="sub">
  99     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 100  </div>
 101 <div class="menu">
 102   <a title="Resources" href="../../www/resources.html">Resources</a>
 103 </div>
 104 <div class="menu">
 105   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 106 </div>
 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="#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>
 156
 157 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 158 _8c.html" target="source" name="AcquireMagickResource">AcquireMagickResource</a></h2>
 159 <div class="doc-section">
 160
 161 <p>AcquireMagickResource() acquires resources of the specified type. MagickFalse is returned if the specified resource is exhausted otherwise MagickTrue.</p></ol>
 162
 163 <p>The format of the AcquireMagickResource() method is:</p>
 164
 165 <pre class="code">
 166   MagickBooleanType AcquireMagickResource(const ResourceType type,
 167     const MagickSizeType size)
 168 </pre>
 169
 170 <p>A description of each parameter follows:</p></ol>
 171
 172 <h5>type</h5>
 173 <ol><p>the type of resource.</p></ol>
 174
 175 <h5>size</h5>
 176 <ol><p>the number of bytes needed from for this resource.</p></ol>
 177
 178  </div>
 179 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 180 _8c.html" target="source" name="AcquireUniqueFileResource">AcquireUniqueFileResource</a></h2>
 181 <div class="doc-section">
 182
 183 <p>AcquireUniqueFileResource() returns a unique file name, and returns a file descriptor for the file open for reading and writing.</p></ol>
 184
 185 <p>The format of the AcquireUniqueFileResource() method is:</p>
 186
 187 <pre class="code">
 188   int AcquireUniqueFileResource(char *path)
 189 </pre>
 190
 191 <p>A description of each parameter follows:</p></ol>
 192
 193 <h5> path</h5>
 194 <ol><p>Specifies a pointer to an array of characters.  The unique path name is returned in this array.</p></ol>
 195
 196  </div>
 197 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 198 _8c.html" target="source" name="GetMagickResource">GetMagickResource</a></h2>
 199 <div class="doc-section">
 200
 201 <p>GetMagickResource() returns the specified resource.</p></ol>
 202
 203 <p>The format of the GetMagickResource() method is:</p>
 204
 205 <pre class="code">
 206   MagickSizeType GetMagickResource(const ResourceType type)
 207 </pre>
 208
 209 <p>A description of each parameter follows:</p></ol>
 210
 211 <h5>type</h5>
 212 <ol><p>the type of resource.</p></ol>
 213
 214  </div>
 215 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 216 _8c.html" target="source" name="GetMagickResource">GetMagickResource</a></h2>
 217 <div class="doc-section">
 218
 219 <p>GetMagickResource() returns the specified resource limit.</p></ol>
 220
 221 <p>The format of the GetMagickResourceLimit() method is:</p>
 222
 223 <pre class="code">
 224   MagickSizeType GetMagickResourceLimit(const ResourceType type)
 225 </pre>
 226
 227 <p>A description of each parameter follows:</p></ol>
 228
 229 <h5>type</h5>
 230 <ol><p>the type of resource.</p></ol>
 231
 232  </div>
 233 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 234 _8c.html" target="source" name="ListMagickResourceInfo">ListMagickResourceInfo</a></h2>
 235 <div class="doc-section">
 236
 237 <p>ListMagickResourceInfo() lists the resource info to a file.</p></ol>
 238
 239 <p>The format of the ListMagickResourceInfo method is:</p>
 240
 241 <pre class="code">
 242   MagickBooleanType ListMagickResourceInfo(FILE *file,
 243     ExceptionInfo *exception)
 244 </pre>
 245
 246 <p>A description of each parameter follows.</p></ol>
 247
 248 <h5>file</h5>
 249 <ol><p>An pointer to a FILE.</p></ol>
 250
 251 <h5>exception</h5>
 252 <ol><p>return any errors or warnings in this structure.</p></ol>
 253
 254  </div>
 255 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 256 _8c.html" target="source" name="RelinquishMagickResource">RelinquishMagickResource</a></h2>
 257 <div class="doc-section">
 258
 259 <p>RelinquishMagickResource() relinquishes resources of the specified type.</p></ol>
 260
 261 <p>The format of the RelinquishMagickResource() method is:</p>
 262
 263 <pre class="code">
 264   void RelinquishMagickResource(const ResourceType type,
 265     const MagickSizeType size)
 266 </pre>
 267
 268 <p>A description of each parameter follows:</p></ol>
 269
 270 <h5>type</h5>
 271 <ol><p>the type of resource.</p></ol>
 272
 273 <h5>size</h5>
 274 <ol><p>the size of the resource.</p></ol>
 275
 276  </div>
 277 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 278 _8c.html" target="source" name="RelinquishUniqueFileResource">RelinquishUniqueFileResource</a></h2>
 279 <div class="doc-section">
 280
 281 <p>RelinquishUniqueFileResource() relinquishes a unique file resource.</p></ol>
 282
 283 <p>The format of the RelinquishUniqueFileResource() method is:</p>
 284
 285 <pre class="code">
 286   MagickBooleanType RelinquishUniqueFileResource(const char *path)
 287 </pre>
 288
 289 <p>A description of each parameter follows:</p></ol>
 290
 291 <h5>name</h5>
 292 <ol><p>the name of the temporary resource.</p></ol>
 293
 294  </div>
 295 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 296 _8c.html" target="source" name="SetMagickResourceLimit">SetMagickResourceLimit</a></h2>
 297 <div class="doc-section">
 298
 299 <p>SetMagickResourceLimit() sets the limit for a particular resource.</p></ol>
 300
 301 <p>The format of the SetMagickResourceLimit() method is:</p>
 302
 303 <pre class="code">
 304   MagickBooleanType SetMagickResourceLimit(const ResourceType type,
 305     const MagickSizeType limit)
 306 </pre>
 307
 308 <p>A description of each parameter follows:</p></ol>
 309
 310 <h5>type</h5>
 311 <ol><p>the type of resource.</p></ol>
 312
 313 <h5>limit</h5>
 314 <ol><p>the maximum limit for the resource.</p></ol>
 315
 316  </div>
 317 \r
 318 </div>\r
 319 \r
 320 <div id="linkbar">\r
 321  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 322     <span id="linkbar-center">\r
 323       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 324     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 325     </span>\r
 326     <span id="linkbar-east">&nbsp;</span>\r
 327   </div>\r
 328   <div class="footer">\r
 329     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 330     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 331   </div>\r
 332   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 333 </body>\r
 334 </html>\r