blob: c04f9f262cc0f0cdd18ebddfde9171c778e88958 [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +00001<!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 +00003<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +00004<head>
cristy3c98a4f2010-08-13 20:09:41 +00005 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
7 <title>ImageMagick: MagickCore, C API for ImageMagick: Monitor or Limit Resource Consumption</title/>
cristy3ed852e2009-09-05 21:47:34 +00008 <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 +000011 <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"/>
cristy3ed852e2009-09-05 21:47:34 +000014 <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 +000016 <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"/>
cristy16af1cb2009-12-11 21:38:29 +000022 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000023 <meta name="Distribution" content="Global"/>
cristy3c98a4f2010-08-13 20:09:41 +000024 <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 +000030</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 +000048<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000049
cristy3ed852e2009-09-05 21:47:34 +000050<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000051 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000052</div>
cristy3eaa0ef2010-03-06 20:35:26 +000053<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000054<div class="menu">
cristybb503372010-05-27 20:51:26 +000055 <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 +000068 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000069</div>
70<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000071 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +000072</div>
73<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000074 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000075</div>
76<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000077 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000078</div>
79<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000080 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000081</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000083 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +000084</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000086 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +000087</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000089 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000090</div>
91<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000092 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +000093</div>
cristy3eaa0ef2010-03-06 20:35:26 +000094<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000095<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000096 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +000097</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000099 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000102 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000103 </div>
104<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000105 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000106</div>
cristybb503372010-05-27 20:51:26 +0000107<div class="menu">
108 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
109</div>
cristy3ed852e2009-09-05 21:47:34 +0000110<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000111 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000112</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000113<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000114<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000115 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000116</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000117<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000118<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000119 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000120</div>
121<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000122 <a title="Site Map: Links"href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000123</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000124<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000125<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000126 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000127
128<div class="sponsbox">
129<div class="sponsor">
cristy24ce5cb2010-09-30 01:46:41 +0000130 <a title="Sponsor: Online-Magazin" href="http://www.unkostenbeitrag.de/">Online-Magazin</a><!-- 20101101000200 -->
cristy73fd1cd2010-09-12 19:14:25 +0000131</div>
132<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000133 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
134</div>
135<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000136 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
137</div>
138<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000139 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristybebec402010-04-23 19:19:08 +0000140</div>
141<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000142 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000143</div>
144<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000145 <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 +0000146</div>
147<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000148 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristyb4c03bb2009-09-27 13:55:46 +0000149</div>
cristy3ed852e2009-09-05 21:47:34 +0000150</div>
151</div>
cristyce69bb02010-07-27 19:49:46 +0000152</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000153
cristyce69bb02010-07-27 19:49:46 +0000154<div class="eastbar">
155 <script type="text/javascript">
156 <!--
157 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000158 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 +0000166</div>
167
168<div class="main">
169
cristy24ce5cb2010-09-30 01:46:41 +0000170<p class="navigation-index">[<a href="#AcquireMagickResource">AcquireMagickResource</a> &bull; <a href="#AsynchronousResourceComponentTerminus">AsynchronousResourceComponentTerminus</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 +0000171
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
cristy24ce5cb2010-09-30 01:46:41 +0000195_8c.html" target="source" name="AsynchronousResourceComponentTerminus">AsynchronousResourceComponentTerminus</a></h2>
196<div class="doc-section">
197
198<p>AsynchronousResourceComponentTerminus() destroys the resource environment. It differs from ResourceComponentTerminus() in that it can be called from a asynchronous signal handler.</p></ol>
199
200<p>The format of the ResourceComponentTerminus() method is:</p>
201
202<pre class="code">
203 ResourceComponentTerminus(void)
204</pre>
205
206 </div>
207<h2><a href="http://www.imagemagick.org/api/MagickCore/resource
cristy3ed852e2009-09-05 21:47:34 +0000208_8c.html" target="source" name="AcquireUniqueFileResource">AcquireUniqueFileResource</a></h2>
209<div class="doc-section">
210
211<p>AcquireUniqueFileResource() returns a unique file name, and returns a file descriptor for the file open for reading and writing.</p></ol>
212
213<p>The format of the AcquireUniqueFileResource() method is:</p>
214
215<pre class="code">
216 int AcquireUniqueFileResource(char *path)
217</pre>
218
219<p>A description of each parameter follows:</p></ol>
220
221<h5> path</h5>
222<ol><p>Specifies a pointer to an array of characters. The unique path name is returned in this array.</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.</p></ol>
230
231<p>The format of the GetMagickResource() method is:</p>
232
233<pre class="code">
234 MagickSizeType GetMagickResource(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="GetMagickResource">GetMagickResource</a></h2>
245<div class="doc-section">
246
247<p>GetMagickResource() returns the specified resource limit.</p></ol>
248
249<p>The format of the GetMagickResourceLimit() method is:</p>
250
251<pre class="code">
cristyd75d5d12010-02-16 02:04:50 +0000252 MagickSizeType GetMagickResourceLimit(const ResourceType type)
cristy3ed852e2009-09-05 21:47:34 +0000253</pre>
254
255<p>A description of each parameter follows:</p></ol>
256
257<h5>type</h5>
258<ol><p>the type of resource.</p></ol>
259
260 </div>
261<h2><a href="http://www.imagemagick.org/api/MagickCore/resource
262_8c.html" target="source" name="ListMagickResourceInfo">ListMagickResourceInfo</a></h2>
263<div class="doc-section">
264
265<p>ListMagickResourceInfo() lists the resource info to a file.</p></ol>
266
267<p>The format of the ListMagickResourceInfo method is:</p>
268
269<pre class="code">
270 MagickBooleanType ListMagickResourceInfo(FILE *file,
271 ExceptionInfo *exception)
272</pre>
273
274<p>A description of each parameter follows.</p></ol>
275
276<h5>file</h5>
277<ol><p>An pointer to a FILE.</p></ol>
278
279<h5>exception</h5>
280<ol><p>return any errors or warnings in this structure.</p></ol>
281
282 </div>
283<h2><a href="http://www.imagemagick.org/api/MagickCore/resource
284_8c.html" target="source" name="RelinquishMagickResource">RelinquishMagickResource</a></h2>
285<div class="doc-section">
286
287<p>RelinquishMagickResource() relinquishes resources of the specified type.</p></ol>
288
289<p>The format of the RelinquishMagickResource() method is:</p>
290
291<pre class="code">
292 void RelinquishMagickResource(const ResourceType type,
293 const MagickSizeType size)
294</pre>
295
296<p>A description of each parameter follows:</p></ol>
297
298<h5>type</h5>
299<ol><p>the type of resource.</p></ol>
300
301<h5>size</h5>
302<ol><p>the size of the resource.</p></ol>
303
304 </div>
305<h2><a href="http://www.imagemagick.org/api/MagickCore/resource
306_8c.html" target="source" name="RelinquishUniqueFileResource">RelinquishUniqueFileResource</a></h2>
307<div class="doc-section">
308
309<p>RelinquishUniqueFileResource() relinquishes a unique file resource.</p></ol>
310
311<p>The format of the RelinquishUniqueFileResource() method is:</p>
312
313<pre class="code">
314 MagickBooleanType RelinquishUniqueFileResource(const char *path)
315</pre>
316
317<p>A description of each parameter follows:</p></ol>
318
319<h5>name</h5>
320<ol><p>the name of the temporary resource.</p></ol>
321
322 </div>
323<h2><a href="http://www.imagemagick.org/api/MagickCore/resource
324_8c.html" target="source" name="SetMagickResourceLimit">SetMagickResourceLimit</a></h2>
325<div class="doc-section">
326
327<p>SetMagickResourceLimit() sets the limit for a particular resource.</p></ol>
328
329<p>The format of the SetMagickResourceLimit() method is:</p>
330
331<pre class="code">
332 MagickBooleanType SetMagickResourceLimit(const ResourceType type,
333 const MagickSizeType limit)
334</pre>
335
336<p>A description of each parameter follows:</p></ol>
337
338<h5>type</h5>
339<ol><p>the type of resource.</p></ol>
340
341<h5>limit</h5>
342<ol><p>the maximum limit for the resource.</p></ol>
343
344 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000345
346</div>
347
348<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000349 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000350 <span id="linkbar-center">
351 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000352 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000353 </span>
354 <span id="linkbar-east">&nbsp;</span>
355 </div>
356 <div class="footer">
357 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
358 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
359 </div>
360 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000361 <script type="text/javascript">
362 var _gaq = _gaq || [];
363 _gaq.push(['_setAccount', 'UA-17690367-1']);
364 _gaq.push(['_trackPageview']);
365
366 (function() {
367 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
368 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
369 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
370 })();
371 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000372</body>
373</html>