Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 307ba18d4753632f19e873143d01e0b6ba2dbaad / . / www / api / resource.html
blob: 0e657933400758c00821b1da3646ccd066182c7a [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame]3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]7 <title>ImageMagick: MagickCore, C API for ImageMagick: Monitor or Limit Resource Consumption</title>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]11 <meta name="Application-name" content="ImageMagick"/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]12 <meta name="Description" content="ImageMagick is a software suite to create, edit, or compose bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]13 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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"/>
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]22 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]23 <meta name="Distribution" content="Global"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]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"/>
27 <style type="text/css" media="all">
28 @import url("../../www/magick.css");
29 </style>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]30</head>
31
32<body id="www-imagemagick-org">
33<div class="titlebar">
34<a href="../../index.html">
35 <img src="../../images/script.png" alt="[ImageMagick]"
36 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
37<a href="http://www.networkredux.com">
38 <img src="../../images/networkredux.png" alt="[sponsor]"
39 style="margin: 45px auto; border: 0px; float: left;" /></a>
40<a href="http://www.imagemagick.org/discourse-server/">
41 <img src="../../images/logo.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43<a href="../../index.html">
44 <img src="../../images/sprite.jpg" alt=""
45 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
46</div>
47
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]48<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]49
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]50<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]51 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]52</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]53<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]54<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]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>
67<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]68 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]69</div>
70<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]71 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]72</div>
73<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]74 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]75</div>
76<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]77 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]78</div>
79<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]80 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]81</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]83 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]84</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]86 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]87</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]89 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]90</div>
91<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]92 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]93</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]94<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]95<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]96 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]97</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]99 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]102 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103 </div>
104<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]105 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]106</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]107<div class="menu">
108 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
109</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]110<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]111 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]112</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]113<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]114<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]115 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]116</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]117<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]118<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]119 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
121<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]122 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]123</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]124<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]125<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]126 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]127
128<div class="sponsbox">
129<div class="sponsor">
cristy307ba182010-12-25 01:00:34 +0000[diff] [blame^]130 <a title="Sponsor: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
cristy7d52cd62010-10-01 17:26:59 +0000[diff] [blame]131</div>
132<div class="sponsor">
133 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +0000[diff] [blame]134</div>
135<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]136 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
137</div>
138<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]139 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
140</div>
141<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]142 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristybebec402010-04-23 19:19:08 +0000[diff] [blame]143</div>
144<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]145 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000[diff] [blame]146</div>
147<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]148 <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
cristy916e1922009-10-01 12:52:47 +0000[diff] [blame]149</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]150</div>
151</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]152</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]153
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]154<div class="eastbar">
155 <script type="text/javascript">
156 <!--
157 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]158 google_ad_slot = "0574824969";
159 google_ad_width = 160;
160 google_ad_height = 600;
161 //-->
162 </script>
163 <script type="text/javascript"
164 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
165 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]166</div>
167
168<div class="main">
169
cristy307ba182010-12-25 01:00:34 +0000[diff] [blame^]170<h1>Module resource
171 Methods</h1>
cristy7d52cd62010-10-01 17:26:59 +0000[diff] [blame]172<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]173
174<h2><a href="http://www.imagemagick.org/api/MagickCore/resource
175_8c.html" target="source" name="AcquireMagickResource">AcquireMagickResource</a></h2>
176<div class="doc-section">
177
178<p>AcquireMagickResource() acquires resources of the specified type. MagickFalse is returned if the specified resource is exhausted otherwise MagickTrue.</p></ol>
179
180<p>The format of the AcquireMagickResource() method is:</p>
181
182<pre class="code">
183 MagickBooleanType AcquireMagickResource(const ResourceType type,
184 const MagickSizeType size)
185</pre>
186
187<p>A description of each parameter follows:</p></ol>
188
189<h5>type</h5>
190<ol><p>the type of resource.</p></ol>
191
192<h5>size</h5>
193<ol><p>the number of bytes needed from for this resource.</p></ol>
194
195 </div>
196<h2><a href="http://www.imagemagick.org/api/MagickCore/resource
197_8c.html" target="source" name="AcquireUniqueFileResource">AcquireUniqueFileResource</a></h2>
198<div class="doc-section">
199
200<p>AcquireUniqueFileResource() returns a unique file name, and returns a file descriptor for the file open for reading and writing.</p></ol>
201
202<p>The format of the AcquireUniqueFileResource() method is:</p>
203
204<pre class="code">
205 int AcquireUniqueFileResource(char *path)
206</pre>
207
208<p>A description of each parameter follows:</p></ol>
209
210<h5> path</h5>
211<ol><p>Specifies a pointer to an array of characters. The unique path name is returned in this array.</p></ol>
212
213 </div>
214<h2><a href="http://www.imagemagick.org/api/MagickCore/resource
215_8c.html" target="source" name="GetMagickResource">GetMagickResource</a></h2>
216<div class="doc-section">
217
218<p>GetMagickResource() returns the specified resource.</p></ol>
219
220<p>The format of the GetMagickResource() method is:</p>
221
222<pre class="code">
223 MagickSizeType GetMagickResource(const ResourceType type)
224</pre>
225
226<p>A description of each parameter follows:</p></ol>
227
228<h5>type</h5>
229<ol><p>the type of resource.</p></ol>
230
231 </div>
232<h2><a href="http://www.imagemagick.org/api/MagickCore/resource
233_8c.html" target="source" name="GetMagickResource">GetMagickResource</a></h2>
234<div class="doc-section">
235
236<p>GetMagickResource() returns the specified resource limit.</p></ol>
237
238<p>The format of the GetMagickResourceLimit() method is:</p>
239
240<pre class="code">
cristyd75d5d12010-02-16 02:04:50 +0000[diff] [blame]241 MagickSizeType GetMagickResourceLimit(const ResourceType type)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]242</pre>
243
244<p>A description of each parameter follows:</p></ol>
245
246<h5>type</h5>
247<ol><p>the type of resource.</p></ol>
248
249 </div>
250<h2><a href="http://www.imagemagick.org/api/MagickCore/resource
251_8c.html" target="source" name="ListMagickResourceInfo">ListMagickResourceInfo</a></h2>
252<div class="doc-section">
253
254<p>ListMagickResourceInfo() lists the resource info to a file.</p></ol>
255
256<p>The format of the ListMagickResourceInfo method is:</p>
257
258<pre class="code">
259 MagickBooleanType ListMagickResourceInfo(FILE *file,
260 ExceptionInfo *exception)
261</pre>
262
263<p>A description of each parameter follows.</p></ol>
264
265<h5>file</h5>
266<ol><p>An pointer to a FILE.</p></ol>
267
268<h5>exception</h5>
269<ol><p>return any errors or warnings in this structure.</p></ol>
270
271 </div>
272<h2><a href="http://www.imagemagick.org/api/MagickCore/resource
273_8c.html" target="source" name="RelinquishMagickResource">RelinquishMagickResource</a></h2>
274<div class="doc-section">
275
276<p>RelinquishMagickResource() relinquishes resources of the specified type.</p></ol>
277
278<p>The format of the RelinquishMagickResource() method is:</p>
279
280<pre class="code">
281 void RelinquishMagickResource(const ResourceType type,
282 const MagickSizeType size)
283</pre>
284
285<p>A description of each parameter follows:</p></ol>
286
287<h5>type</h5>
288<ol><p>the type of resource.</p></ol>
289
290<h5>size</h5>
291<ol><p>the size of the resource.</p></ol>
292
293 </div>
294<h2><a href="http://www.imagemagick.org/api/MagickCore/resource
295_8c.html" target="source" name="RelinquishUniqueFileResource">RelinquishUniqueFileResource</a></h2>
296<div class="doc-section">
297
298<p>RelinquishUniqueFileResource() relinquishes a unique file resource.</p></ol>
299
300<p>The format of the RelinquishUniqueFileResource() method is:</p>
301
302<pre class="code">
303 MagickBooleanType RelinquishUniqueFileResource(const char *path)
304</pre>
305
306<p>A description of each parameter follows:</p></ol>
307
308<h5>name</h5>
309<ol><p>the name of the temporary resource.</p></ol>
310
311 </div>
312<h2><a href="http://www.imagemagick.org/api/MagickCore/resource
313_8c.html" target="source" name="SetMagickResourceLimit">SetMagickResourceLimit</a></h2>
314<div class="doc-section">
315
316<p>SetMagickResourceLimit() sets the limit for a particular resource.</p></ol>
317
318<p>The format of the SetMagickResourceLimit() method is:</p>
319
320<pre class="code">
321 MagickBooleanType SetMagickResourceLimit(const ResourceType type,
322 const MagickSizeType limit)
323</pre>
324
325<p>A description of each parameter follows:</p></ol>
326
327<h5>type</h5>
328<ol><p>the type of resource.</p></ol>
329
330<h5>limit</h5>
331<ol><p>the maximum limit for the resource.</p></ol>
332
333 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]334
335</div>
336
337<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]338 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]339 <span id="linkbar-center">
340 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]341 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]342 </span>
343 <span id="linkbar-east">&nbsp;</span>
344 </div>
345 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]346 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]347 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
348 </div>
349 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]350 <script type="text/javascript">
351 var _gaq = _gaq || [];
352 _gaq.push(['_setAccount', 'UA-17690367-1']);
353 _gaq.push(['_trackPageview']);
354
355 (function() {
356 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
357 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
358 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
359 })();
360 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]361</body>
362</html>