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="westbar">\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: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 137 </div>
 138 <div  class="sponsor">
 139    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 140 </div>
 141 <div  class="sponsor">
 142    <a title="Sponsor: Webdesign" href="http://www.renehornig.com/">Webdesign</a><!-- 20111001000240 -->
 143 </div>
 144 </div>
 145 </div>
 146 </div>\r
 147 \r
 148 <div class="eastbar">\r
 149   <script type="text/javascript">\r
 150   <!--\r
 151     google_ad_client = "pub-3129977114552745";\r
 152     /* 160x600, created 7/27/10 */\r
 153     google_ad_slot = "0574824969";\r
 154     google_ad_width = 160;\r
 155     google_ad_height = 600;\r
 156   //-->\r
 157   </script>\r
 158   <script type="text/javascript"\r
 159     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 160   </script>\r
 161 </div>\r
 162 \r
 163 <div class="main">\r
 164 \r
 165 <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>
 166
 167 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 168 _8c.html" target="source" name="AcquireMagickResource">AcquireMagickResource</a></h2>
 169 <div class="doc-section">
 170
 171 <p>AcquireMagickResource() acquires resources of the specified type. MagickFalse is returned if the specified resource is exhausted otherwise MagickTrue.</p></ol>
 172
 173 <p>The format of the AcquireMagickResource() method is:</p>
 174
 175 <pre class="code">
 176   MagickBooleanType AcquireMagickResource(const ResourceType type,
 177     const MagickSizeType size)
 178 </pre>
 179
 180 <p>A description of each parameter follows:</p></ol>
 181
 182 <h5>type</h5>
 183 <ol><p>the type of resource.</p></ol>
 184
 185 <h5>size</h5>
 186 <ol><p>the number of bytes needed from for this resource.</p></ol>
 187
 188  </div>
 189 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 190 _8c.html" target="source" name="AcquireUniqueFileResource">AcquireUniqueFileResource</a></h2>
 191 <div class="doc-section">
 192
 193 <p>AcquireUniqueFileResource() returns a unique file name, and returns a file descriptor for the file open for reading and writing.</p></ol>
 194
 195 <p>The format of the AcquireUniqueFileResource() method is:</p>
 196
 197 <pre class="code">
 198   int AcquireUniqueFileResource(char *path)
 199 </pre>
 200
 201 <p>A description of each parameter follows:</p></ol>
 202
 203 <h5> path</h5>
 204 <ol><p>Specifies a pointer to an array of characters.  The unique path name is returned in this array.</p></ol>
 205
 206  </div>
 207 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 208 _8c.html" target="source" name="GetMagickResource">GetMagickResource</a></h2>
 209 <div class="doc-section">
 210
 211 <p>GetMagickResource() returns the specified resource.</p></ol>
 212
 213 <p>The format of the GetMagickResource() method is:</p>
 214
 215 <pre class="code">
 216   MagickSizeType GetMagickResource(const ResourceType type)
 217 </pre>
 218
 219 <p>A description of each parameter follows:</p></ol>
 220
 221 <h5>type</h5>
 222 <ol><p>the type of resource.</p></ol>
 223
 224  </div>
 225 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 226 _8c.html" target="source" name="GetMagickResource">GetMagickResource</a></h2>
 227 <div class="doc-section">
 228
 229 <p>GetMagickResource() returns the specified resource limit.</p></ol>
 230
 231 <p>The format of the GetMagickResourceLimit() method is:</p>
 232
 233 <pre class="code">
 234   MagickSizeType GetMagickResourceLimit(const ResourceType type)
 235 </pre>
 236
 237 <p>A description of each parameter follows:</p></ol>
 238
 239 <h5>type</h5>
 240 <ol><p>the type of resource.</p></ol>
 241
 242  </div>
 243 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 244 _8c.html" target="source" name="ListMagickResourceInfo">ListMagickResourceInfo</a></h2>
 245 <div class="doc-section">
 246
 247 <p>ListMagickResourceInfo() lists the resource info to a file.</p></ol>
 248
 249 <p>The format of the ListMagickResourceInfo method is:</p>
 250
 251 <pre class="code">
 252   MagickBooleanType ListMagickResourceInfo(FILE *file,
 253     ExceptionInfo *exception)
 254 </pre>
 255
 256 <p>A description of each parameter follows.</p></ol>
 257
 258 <h5>file</h5>
 259 <ol><p>An pointer to a FILE.</p></ol>
 260
 261 <h5>exception</h5>
 262 <ol><p>return any errors or warnings in this structure.</p></ol>
 263
 264  </div>
 265 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 266 _8c.html" target="source" name="RelinquishMagickResource">RelinquishMagickResource</a></h2>
 267 <div class="doc-section">
 268
 269 <p>RelinquishMagickResource() relinquishes resources of the specified type.</p></ol>
 270
 271 <p>The format of the RelinquishMagickResource() method is:</p>
 272
 273 <pre class="code">
 274   void RelinquishMagickResource(const ResourceType type,
 275     const MagickSizeType size)
 276 </pre>
 277
 278 <p>A description of each parameter follows:</p></ol>
 279
 280 <h5>type</h5>
 281 <ol><p>the type of resource.</p></ol>
 282
 283 <h5>size</h5>
 284 <ol><p>the size of the resource.</p></ol>
 285
 286  </div>
 287 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 288 _8c.html" target="source" name="RelinquishUniqueFileResource">RelinquishUniqueFileResource</a></h2>
 289 <div class="doc-section">
 290
 291 <p>RelinquishUniqueFileResource() relinquishes a unique file resource.</p></ol>
 292
 293 <p>The format of the RelinquishUniqueFileResource() method is:</p>
 294
 295 <pre class="code">
 296   MagickBooleanType RelinquishUniqueFileResource(const char *path)
 297 </pre>
 298
 299 <p>A description of each parameter follows:</p></ol>
 300
 301 <h5>name</h5>
 302 <ol><p>the name of the temporary resource.</p></ol>
 303
 304  </div>
 305 <h2><a href="http://www.imagemagick.org/api/MagickCore/resource
 306 _8c.html" target="source" name="SetMagickResourceLimit">SetMagickResourceLimit</a></h2>
 307 <div class="doc-section">
 308
 309 <p>SetMagickResourceLimit() sets the limit for a particular resource.</p></ol>
 310
 311 <p>The format of the SetMagickResourceLimit() method is:</p>
 312
 313 <pre class="code">
 314   MagickBooleanType SetMagickResourceLimit(const ResourceType type,
 315     const MagickSizeType limit)
 316 </pre>
 317
 318 <p>A description of each parameter follows:</p></ol>
 319
 320 <h5>type</h5>
 321 <ol><p>the type of resource.</p></ol>
 322
 323 <h5>limit</h5>
 324 <ol><p>the maximum limit for the resource.</p></ol>
 325
 326  </div>
 327 \r
 328 </div>\r
 329 \r
 330 <div id="linkbar">\r
 331     <span id="linkbar-west">&nbsp;</span>\r
 332     <span id="linkbar-center">\r
 333       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 334       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 335     </span>\r
 336     <span id="linkbar-east">&nbsp;</span>\r
 337   </div>\r
 338   <div class="footer">\r
 339     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 340     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 341   </div>\r
 342   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 343   <script type="text/javascript">\r
 344     var _gaq = _gaq || [];\r
 345     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 346     _gaq.push(['_trackPageview']);\r
 347 \r
 348     (function() {\r
 349       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 350       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 351       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 352     })();\r
 353   </script>\r
 354 </body>\r
 355 </html>\r