granicus.if.org Git - imagemagick/blob - www/api/resource.php

   1 \r
   2 \r
   3 \r
   4 \r
   5 <!DOCTYPE html>
   6 <html lang="en">
   7 <head>
   8   <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
   9     <title>ImageMagick: MagickCore, C API for ImageMagick: Monitor or Limit Resource Consumption</title>
  10   <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
  11   <meta name="application-name" content="ImageMagick"/>
  12   <meta name="description" content="ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves."/>
  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, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert"/>
  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-2015 ImageMagick Studio LLC"/>
  23   <meta name="distribution" content="Global"/>
  24   <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1"/>
  25   <link rel="icon" href="../image/wand.png">
  26   <link rel="shortcut icon" href="../image/wand.ico">
  27   <link rel="stylesheet" href="../css/magick.php">
  28 </head>
  29 <body>
  30 <div class="main">
  31 <div class="magick-masthead">
  32   <div class="container">
  33     <script async src="http://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>    <ins class="adsbygoogle"
  34          style="display:block"
  35          data-ad-client="ca-pub-3129977114552745"
  36          data-ad-slot="6345125851"
  37          data-ad-format="auto"></ins>
  38     <script>
  39     (adsbygoogle = window.adsbygoogle || []).push({});
  40     </script>
  41     <nav class="magick-nav">
  42       <a class="magick-nav-item " href="../index.php">Home</a>
  43       <a class="magick-nav-item " href="../script/binary-releases.php">Download</a>
  44       <a class="magick-nav-item " href="../script/command-line-tools.php">Tools</a>
  45       <a class="magick-nav-item " href="../script/command-line-options.php">Options</a>
  46       <a class="magick-nav-item " href="../script/resources.php">Resources</a>
  47       <a class="magick-nav-item " href="../script/api.php">Develop</a>
  48       <a class="magick-nav-item " href="../script/search.php">Search</a>
  49       <a class="magick-nav-item pull-right" href="http://www.imagemagick.org/discourse-server/">Community</a>
  50     </nav>
  51   </div>
  52 </div>
  53 <div class="container">
  54 <div class="magick-header">
  55 <p class="text-center"><a href="resource.php#AcquireMagickResource">AcquireMagickResource</a> &bull; <a href="resource.php#AcquireUniqueFileResource">AcquireUniqueFileResource</a> &bull; <a href="resource.php#GetMagickResource">GetMagickResource</a> &bull; <a href="resource.php#GetMagickResourceLimit">GetMagickResourceLimit</a> &bull; <a href="resource.php#ListMagickResourceInfo">ListMagickResourceInfo</a> &bull; <a href="resource.php#RelinquishMagickResource">RelinquishMagickResource</a> &bull; <a href="resource.php#RelinquishUniqueFileResource">RelinquishUniqueFileResource</a> &bull; <a href="resource.php#SetMagickResourceLimit">SetMagickResourceLimit</a></p>
  56
  57 <h2><a href="http://nextgen.imagemagick.org/api/MagickCore/resource_8c.html" id="AcquireMagickResource">AcquireMagickResource</a></h2>
  58
  59 <p>AcquireMagickResource() acquires resources of the specified type. MagickFalse is returned if the specified resource is exhausted otherwise MagickTrue.</p>
  60
  61 <p>The format of the AcquireMagickResource() method is:</p>
  62
  63 <pre class="text">
  64 MagickBooleanType AcquireMagickResource(const ResourceType type,
  65   const MagickSizeType size)
  66 </pre>
  67
  68 <p>A description of each parameter follows:</p>
  69
  70 <dd>
  71 </dd>
  72
  73 <dd> </dd>
  74 <dl class="dl-horizontal">
  75 <dt>type</dt>
  76 <dd>the type of resource. </dd>
  77
  78 <dd> </dd>
  79 <dt>size</dt>
  80 <dd>the number of bytes needed from for this resource. </dd>
  81
  82 <dd>  </dd>
  83 </dl>
  84 <h2><a href="http://nextgen.imagemagick.org/api/MagickCore/resource_8c.html" id="AcquireUniqueFileResource">AcquireUniqueFileResource</a></h2>
  85
  86 <p>AcquireUniqueFileResource() returns a unique file name, and returns a file descriptor for the file open for reading and writing.</p>
  87
  88 <p>The format of the AcquireUniqueFileResource() method is:</p>
  89
  90 <pre class="text">
  91 int AcquireUniqueFileResource(char *path)
  92 </pre>
  93
  94 <p>A description of each parameter follows:</p>
  95
  96 <dd>
  97 </dd>
  98
  99 <dd> </dd>
 100 <dl class="dl-horizontal">
 101 <dt> path</dt>
 102 <dd> Specifies a pointer to an array of characters.  The unique path name is returned in this array. </dd>
 103
 104 <dd>  </dd>
 105 </dl>
 106 <h2><a href="http://nextgen.imagemagick.org/api/MagickCore/resource_8c.html" id="GetMagickResource">GetMagickResource</a></h2>
 107
 108 <p>GetMagickResource() returns the specified resource.</p>
 109
 110 <p>The format of the GetMagickResource() method is:</p>
 111
 112 <pre class="text">
 113 MagickSizeType GetMagickResource(const ResourceType type)
 114 </pre>
 115
 116 <p>A description of each parameter follows:</p>
 117
 118 <dd>
 119 </dd>
 120
 121 <dd> </dd>
 122 <dl class="dl-horizontal">
 123 <dt>type</dt>
 124 <dd>the type of resource. </dd>
 125
 126 <dd>  </dd>
 127 </dl>
 128 <h2><a href="http://nextgen.imagemagick.org/api/MagickCore/resource_8c.html" id="GetMagickResourceLimit">GetMagickResourceLimit</a></h2>
 129
 130 <p>GetMagickResourceLimit() returns the specified resource limit.</p>
 131
 132 <p>The format of the GetMagickResourceLimit() method is:</p>
 133
 134 <pre class="text">
 135 MagickSizeType GetMagickResourceLimit(const ResourceType type)
 136 </pre>
 137
 138 <p>A description of each parameter follows:</p>
 139
 140 <dd>
 141 </dd>
 142
 143 <dd> </dd>
 144 <dl class="dl-horizontal">
 145 <dt>type</dt>
 146 <dd>the type of resource. </dd>
 147
 148 <dd>  </dd>
 149 </dl>
 150 <h2><a href="http://nextgen.imagemagick.org/api/MagickCore/resource_8c.html" id="ListMagickResourceInfo">ListMagickResourceInfo</a></h2>
 151
 152 <p>ListMagickResourceInfo() lists the resource info to a file.</p>
 153
 154 <p>The format of the ListMagickResourceInfo method is:</p>
 155
 156 <pre class="text">
 157 MagickBooleanType ListMagickResourceInfo(FILE *file,
 158   ExceptionInfo *exception)
 159 </pre>
 160
 161 <p>A description of each parameter follows.</p>
 162
 163 <dt>file</dt>
 164 <p>An pointer to a FILE.</p>
 165
 166 <dt>exception</dt>
 167 <p>return any errors or warnings in this structure.</p>
 168
 169 <h2><a href="http://nextgen.imagemagick.org/api/MagickCore/resource_8c.html" id="RelinquishMagickResource">RelinquishMagickResource</a></h2>
 170
 171 <p>RelinquishMagickResource() relinquishes resources of the specified type.</p>
 172
 173 <p>The format of the RelinquishMagickResource() method is:</p>
 174
 175 <pre class="text">
 176 void RelinquishMagickResource(const ResourceType type,
 177   const MagickSizeType size)
 178 </pre>
 179
 180 <p>A description of each parameter follows:</p>
 181
 182 <dd>
 183 </dd>
 184
 185 <dd> </dd>
 186 <dl class="dl-horizontal">
 187 <dt>type</dt>
 188 <dd>the type of resource. </dd>
 189
 190 <dd> </dd>
 191 <dt>size</dt>
 192 <dd>the size of the resource. </dd>
 193
 194 <dd>  </dd>
 195 </dl>
 196 <h2><a href="http://nextgen.imagemagick.org/api/MagickCore/resource_8c.html" id="RelinquishUniqueFileResource">RelinquishUniqueFileResource</a></h2>
 197
 198 <p>RelinquishUniqueFileResource() relinquishes a unique file resource.</p>
 199
 200 <p>The format of the RelinquishUniqueFileResource() method is:</p>
 201
 202 <pre class="text">
 203 MagickBooleanType RelinquishUniqueFileResource(const char *path)
 204 </pre>
 205
 206 <p>A description of each parameter follows:</p>
 207
 208 <dd>
 209 </dd>
 210
 211 <dd> </dd>
 212 <dl class="dl-horizontal">
 213 <dt>name</dt>
 214 <dd>the name of the temporary resource. </dd>
 215
 216 <dd>  </dd>
 217 </dl>
 218 <h2><a href="http://nextgen.imagemagick.org/api/MagickCore/resource_8c.html" id="SetMagickResourceLimit">SetMagickResourceLimit</a></h2>
 219
 220 <p>SetMagickResourceLimit() sets the limit for a particular resource.</p>
 221
 222 <p>The format of the SetMagickResourceLimit() method is:</p>
 223
 224 <pre class="text">
 225 MagickBooleanType SetMagickResourceLimit(const ResourceType type,
 226   const MagickSizeType limit)
 227 </pre>
 228
 229 <p>A description of each parameter follows:</p>
 230
 231 <dd>
 232 </dd>
 233
 234 <dd> </dd>
 235 <dl class="dl-horizontal">
 236 <dt>type</dt>
 237 <dd>the type of resource. </dd>
 238
 239 <dd> </dd>
 240 <dt>limit</dt>
 241 <dd>the maximum limit for the resource. </dd>
 242
 243 <dd>  </dd>
 244 </dl>
 245 </div>
 246   <footer class="magick-footer">
 247     <p><a href="../script/support.php">Donate</a> •
 248      <a href="../script/sitemap.php">Sitemap</a> •
 249     <a href="../script/links.php">Related</a> •
 250     <a href="../script/architecture.php">Architecture</a>
 251 </p>
 252     <p><a href="resource.php#">Back to top</a> •
 253     <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
 254     <a href="../script/contact.php">Contact Us</a></p>
 255         <p><small>&copy; 1999-2015 ImageMagick Studio LLC</small></p>
 256   </footer>
 257 </div><!-- /.container -->
 258
 259   <script src="http://nextgen.imagemagick.org/js/magick.php"></script>
 260 </div>
 261 </body>
 262 </html>