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   <title>ImageMagick: MagickCore, C API for ImageMagick: Monitor or Limit Resource Consumption</title/>
   8   <meta http-equiv="Content-Language" content="en-US"/>
   9   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  10   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  11   <meta name="Application-name" content="ImageMagick"/>
  12   <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."/>
  13   <meta name="Application-url" content="http://www.imagemagick.org"/>
  14   <meta name="Generator" content="PHP"/>
  15   <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"/>
  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-2010 ImageMagick Studio LLC"/>
  23   <meta name="Distribution" content="Global"/>
  24   <link rel="icon" href="../../images/wand.png"  sizes="32x32"/>
  25   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/x-icon"/>
  26   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
  27   <style type="text/css" media="all">\r
  28     @import url("../../www/magick.css");\r
  29   </style>\r
  30 </head>\r
  31 \r
  32 <body id="www-imagemagick-org">\r
  33 <div class="titlebar">\r
  34 <a href="../../index.html">\r
  35   <img src="../../images/script.png" alt="[ImageMagick]"\r
  36   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  37 <a href="http://www.networkredux.com">\r
  38   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  39   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  40 <a href="http://www.imagemagick.org/discourse-server/">\r
  41   <img src="../../images/logo.jpg" alt=""\r
  42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  43 <a href="../../index.html">\r
  44   <img src="../../images/sprite.jpg" alt=""\r
  45   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  46 </div>\r
  47 \r
  48 <div class="westbar">\r
  49 \r
  50 <div class="menu">
  51   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  52 </div>
  53 <div class="sep"></div>\r
  54 <div class="menu">
  55   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  56 </div>
  57 <div class="sub">
  58     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  59 </div>
  60 <div class="sub">
  61     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  62 </div>
  63 <div class="sub">
  64     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
  65 </div>
  66 <div class="sep"></div>\r
  67 <div class="menu">
  68   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  69 </div>
  70 <div class="sub">
  71     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  72 </div>
  73 <div class="sub">
  74     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  75 </div>
  76 <div class="sub">
  77     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  78 </div>
  79 <div class="menu">
  80   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
  81 </div>
  82 <div class="sub">
  83     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
  84 </div>
  85 <div class="sub">
  86     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
  87 </div>
  88 <div class="sub">
  89     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
  90 </div>
  91 <div class="sub">
  92     <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
  93 </div>
  94 <div class="sep"></div>\r
  95 <div  class="menu">
  96    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
  97 </div>
  98 <div class="sub">
  99     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
 100 </div>
 101 <div class="sub">
 102     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 103  </div>
 104 <div class="menu">
 105   <a title="Resources" href="../../www/resources.html">Resources</a>
 106 </div>
 107 <div class="menu">
 108   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 109 </div>
 110 <div class="menu">
 111   <a title="Download" href="../../www/download.html">Download</a>
 112 </div>
 113 <div class="sep"></div>\r
 114 <div class="menu">
 115   <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
 116 </div>
 117 <div class="sep"></div>\r
 118 <div class="menu">
 119   <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
 120 </div>
 121 <div  class="sub">
 122     <a title="Site Map: Links"href="../../www/links.html">Links</a>
 123 </div>
 124 <div class="sep"></div>\r
 125 <div  class="menu">
 126   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 127
 128 <div class="sponsbox">
 129 <div  class="sponsor">
 130   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 131 </div>
 132 <div  class="sponsor">
 133   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 134 </div>
 135 <div  class="sponsor">
 136   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 137 </div>
 138 <div  class="sponsor">
 139   <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
 140 </div>
 141 <div  class="sponsor">
 142   <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 143 </div>
 144 <div  class="sponsor">
 145    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 146 </div>
 147 <div  class="sponsor">
 148    <a title="Sponsor: Online-Magazin" href="http://www.unkostenbeitrag.de/">Online-Magazin</a><!-- 20101101000200 -->
 149 </div>
 150 </div>
 151 </div>
 152 </div>\r
 153 \r
 154 <div class="eastbar">\r
 155   <script type="text/javascript">\r
 156   <!--\r
 157     google_ad_client = "pub-3129977114552745";\r
 158     google_ad_slot = "0574824969";\r
 159     google_ad_width = 160;\r
 160     google_ad_height = 600;\r
 161   //-->\r
 162   </script>\r
 163   <script type="text/javascript"\r
 164     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 165   </script>\r
 166 </div>\r
 167 \r
 168 <div class="main">\r
 169 \r
 170 <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>
 171
 172 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 173 _8c.html" target="source" name="AcquireMagickResource">AcquireMagickResource</a></h2>
 174 <div class="doc-section">
 175
 176 <p>AcquireMagickResource() acquires resources of the specified type. MagickFalse is returned if the specified resource is exhausted otherwise MagickTrue.</p></ol>
 177
 178 <p>The format of the AcquireMagickResource() method is:</p>
 179
 180 <pre class="code">
 181   MagickBooleanType AcquireMagickResource(const ResourceType type,
 182     const MagickSizeType size)
 183 </pre>
 184
 185 <p>A description of each parameter follows:</p></ol>
 186
 187 <h5>type</h5>
 188 <ol><p>the type of resource.</p></ol>
 189
 190 <h5>size</h5>
 191 <ol><p>the number of bytes needed from for this resource.</p></ol>
 192
 193  </div>
 194 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 195 _8c.html" target="source" name="AcquireUniqueFileResource">AcquireUniqueFileResource</a></h2>
 196 <div class="doc-section">
 197
 198 <p>AcquireUniqueFileResource() returns a unique file name, and returns a file descriptor for the file open for reading and writing.</p></ol>
 199
 200 <p>The format of the AcquireUniqueFileResource() method is:</p>
 201
 202 <pre class="code">
 203   int AcquireUniqueFileResource(char *path)
 204 </pre>
 205
 206 <p>A description of each parameter follows:</p></ol>
 207
 208 <h5> path</h5>
 209 <ol><p>Specifies a pointer to an array of characters.  The unique path name is returned in this array.</p></ol>
 210
 211  </div>
 212 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 213 _8c.html" target="source" name="GetMagickResource">GetMagickResource</a></h2>
 214 <div class="doc-section">
 215
 216 <p>GetMagickResource() returns the specified resource.</p></ol>
 217
 218 <p>The format of the GetMagickResource() method is:</p>
 219
 220 <pre class="code">
 221   MagickSizeType GetMagickResource(const ResourceType type)
 222 </pre>
 223
 224 <p>A description of each parameter follows:</p></ol>
 225
 226 <h5>type</h5>
 227 <ol><p>the type of resource.</p></ol>
 228
 229  </div>
 230 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 231 _8c.html" target="source" name="GetMagickResource">GetMagickResource</a></h2>
 232 <div class="doc-section">
 233
 234 <p>GetMagickResource() returns the specified resource limit.</p></ol>
 235
 236 <p>The format of the GetMagickResourceLimit() method is:</p>
 237
 238 <pre class="code">
 239   MagickSizeType GetMagickResourceLimit(const ResourceType type)
 240 </pre>
 241
 242 <p>A description of each parameter follows:</p></ol>
 243
 244 <h5>type</h5>
 245 <ol><p>the type of resource.</p></ol>
 246
 247  </div>
 248 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 249 _8c.html" target="source" name="ListMagickResourceInfo">ListMagickResourceInfo</a></h2>
 250 <div class="doc-section">
 251
 252 <p>ListMagickResourceInfo() lists the resource info to a file.</p></ol>
 253
 254 <p>The format of the ListMagickResourceInfo method is:</p>
 255
 256 <pre class="code">
 257   MagickBooleanType ListMagickResourceInfo(FILE *file,
 258     ExceptionInfo *exception)
 259 </pre>
 260
 261 <p>A description of each parameter follows.</p></ol>
 262
 263 <h5>file</h5>
 264 <ol><p>An pointer to a FILE.</p></ol>
 265
 266 <h5>exception</h5>
 267 <ol><p>return any errors or warnings in this structure.</p></ol>
 268
 269  </div>
 270 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 271 _8c.html" target="source" name="RelinquishMagickResource">RelinquishMagickResource</a></h2>
 272 <div class="doc-section">
 273
 274 <p>RelinquishMagickResource() relinquishes resources of the specified type.</p></ol>
 275
 276 <p>The format of the RelinquishMagickResource() method is:</p>
 277
 278 <pre class="code">
 279   void RelinquishMagickResource(const ResourceType type,
 280     const MagickSizeType size)
 281 </pre>
 282
 283 <p>A description of each parameter follows:</p></ol>
 284
 285 <h5>type</h5>
 286 <ol><p>the type of resource.</p></ol>
 287
 288 <h5>size</h5>
 289 <ol><p>the size of the resource.</p></ol>
 290
 291  </div>
 292 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 293 _8c.html" target="source" name="RelinquishUniqueFileResource">RelinquishUniqueFileResource</a></h2>
 294 <div class="doc-section">
 295
 296 <p>RelinquishUniqueFileResource() relinquishes a unique file resource.</p></ol>
 297
 298 <p>The format of the RelinquishUniqueFileResource() method is:</p>
 299
 300 <pre class="code">
 301   MagickBooleanType RelinquishUniqueFileResource(const char *path)
 302 </pre>
 303
 304 <p>A description of each parameter follows:</p></ol>
 305
 306 <h5>name</h5>
 307 <ol><p>the name of the temporary resource.</p></ol>
 308
 309  </div>
 310 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 311 _8c.html" target="source" name="SetMagickResourceLimit">SetMagickResourceLimit</a></h2>
 312 <div class="doc-section">
 313
 314 <p>SetMagickResourceLimit() sets the limit for a particular resource.</p></ol>
 315
 316 <p>The format of the SetMagickResourceLimit() method is:</p>
 317
 318 <pre class="code">
 319   MagickBooleanType SetMagickResourceLimit(const ResourceType type,
 320     const MagickSizeType limit)
 321 </pre>
 322
 323 <p>A description of each parameter follows:</p></ol>
 324
 325 <h5>type</h5>
 326 <ol><p>the type of resource.</p></ol>
 327
 328 <h5>limit</h5>
 329 <ol><p>the maximum limit for the resource.</p></ol>
 330
 331  </div>
 332 \r
 333 </div>\r
 334 \r
 335 <div id="linkbar">\r
 336     <span id="linkbar-west">&nbsp;</span>\r
 337     <span id="linkbar-center">\r
 338       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 339       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 340     </span>\r
 341     <span id="linkbar-east">&nbsp;</span>\r
 342   </div>\r
 343   <div class="footer">\r
 344     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 345     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 346   </div>\r
 347   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 348   <script type="text/javascript">\r
 349     var _gaq = _gaq || [];\r
 350     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 351     _gaq.push(['_trackPageview']);\r
 352 \r
 353     (function() {\r
 354       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 355       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 356       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 357     })();\r
 358   </script>\r
 359 </body>\r
 360 </html>\r