Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 6886a7561ce8dffd35ccc6803665933f4e66c2d7 / . / www / api / resource.html
blob: b577210af16aa2d051c724657e284b0d96374223 [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>
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]5 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
7 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]8 <style type="text/css" media="all">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]9 @import url("../../www/magick.css");
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]10 </style>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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"/>
cristy16af1cb2009-12-11 21:38:29 +0000[diff] [blame]25 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]26 <meta name="Distribution" content="Global"/>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]27</head>
28
29<body id="www-imagemagick-org">
30<div class="titlebar">
31<a href="../../index.html">
32 <img src="../../images/script.png" alt="[ImageMagick]"
33 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
34<a href="http://www.networkredux.com">
35 <img src="../../images/networkredux.png" alt="[sponsor]"
36 style="margin: 45px auto; border: 0px; float: left;" /></a>
37<a href="http://www.imagemagick.org/discourse-server/">
38 <img src="../../images/logo.jpg" alt=""
39 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
40<a href="../../index.html">
41 <img src="../../images/sprite.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43</div>
44
45<div class="eastbar">
46
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]47<div class="menu">
48 <a href="../../index.html">About ImageMagick</a>
49</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]50<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]51<div class="menu">
52 <a href="../../www/command-line-tools.html">Command-line Tools</a>
53</div>
54<div class="sub">
55 <a href="../../www/command-line-processing.html">Processing</a>
56</div>
57<div class="sub">
58 <a href="../../www/command-line-options.html">Options</a>
59</div>
60<div class="sub">
61 <a href="http://www.imagemagick.org/Usage/">Usage</a>
62</div>
63<div class="menu">
64 <a href="../../www/api.html">Program Interfaces</a>
65</div>
66<div class="sub">
67 <a href="../../www/magick-wand.html">MagickWand</a>
68</div>
69<div class="sub">
70 <a href="../../www/magick-core.html">MagickCore</a>
71</div>
72<div class="sub">
73 <a href="../../www/perl-magick.html">PerlMagick</a>
74</div>
75<div class="sub">
76 <a href="../../Magick++/">Magick++</a>
77</div>
78<div class="menu">
79 <a href="../../www/architecture.html">Architecture</a>
80</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]81<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]82<div class="menu">
83 <a href="../../www/install-source.html">Install from Source</a>
84</div>
85<div class="sub">
86 <a href="../../www/install-source.html#unix">Unix</a>
87</div>
88<div class="sub">
89 <a href="../../www/install-source.html#windows">Windows</a>
90 </div>
91<div class="menu">
92 <a href="../../www/binary-releases.html">Binary Releases</a>
93</div>
94<div class="sub">
95 <a href="../../www/binary-releases.html#unix">Unix</a>
96</div>
97<div class="sub">
98 <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
99</div>
100<div class="sub">
101 <a href="../../www/binary-releases.html#windows">Windows</a>
102</div>
103<div class="menu">
104 <a href="../../www/resources.html">Resources</a>
105</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]106<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107<div class="menu">
108 <a href="../../www/download.html">Download</a>
109</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111<div class="menu">
112 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]115<div class="menu">
116 <a href="../../www/sitemap.html">Site Map</a>
117</div>
118<div class="sub">
119 <a href="../../www/links.html">Links</a>
120</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]121<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]122<div class="menu">
123 <a href="../../www/sponsors.html">Sponsors:</a>
124
125<div class="sponsbox">
126<div class="sponsor">
cristy8f900122010-03-05 15:26:31 +0000[diff] [blame]127 <a href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
128</div>
129<div class="sponsor">
cristy1f9e1ed2009-11-18 04:09:38 +0000[diff] [blame]130 <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
131</div>
132<div class="sponsor">
cristycdbe2742010-02-07 19:30:44 +0000[diff] [blame]133 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
cristy0f61e612009-11-10 20:03:57 +0000[diff] [blame]134</div>
135<div class="sponsor">
136 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
cristy916e1922009-10-01 12:52:47 +0000[diff] [blame]137</div>
138<div class="sponsor">
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]139 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
140</div>
141<div class="sponsor">
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]142 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]143</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]144</div>
145</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]146
147
148</div>
149
150<div class="main">
151
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]152<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>
153
154<h2><a href="http://www.imagemagick.org/api/MagickCore/resource
155_8c.html" target="source" name="AcquireMagickResource">AcquireMagickResource</a></h2>
156<div class="doc-section">
157
158<p>AcquireMagickResource() acquires resources of the specified type. MagickFalse is returned if the specified resource is exhausted otherwise MagickTrue.</p></ol>
159
160<p>The format of the AcquireMagickResource() method is:</p>
161
162<pre class="code">
163 MagickBooleanType AcquireMagickResource(const ResourceType type,
164 const MagickSizeType size)
165</pre>
166
167<p>A description of each parameter follows:</p></ol>
168
169<h5>type</h5>
170<ol><p>the type of resource.</p></ol>
171
172<h5>size</h5>
173<ol><p>the number of bytes needed from for this resource.</p></ol>
174
175 </div>
176<h2><a href="http://www.imagemagick.org/api/MagickCore/resource
177_8c.html" target="source" name="AcquireUniqueFileResource">AcquireUniqueFileResource</a></h2>
178<div class="doc-section">
179
180<p>AcquireUniqueFileResource() returns a unique file name, and returns a file descriptor for the file open for reading and writing.</p></ol>
181
182<p>The format of the AcquireUniqueFileResource() method is:</p>
183
184<pre class="code">
185 int AcquireUniqueFileResource(char *path)
186</pre>
187
188<p>A description of each parameter follows:</p></ol>
189
190<h5> path</h5>
191<ol><p>Specifies a pointer to an array of characters. The unique path name is returned in this array.</p></ol>
192
193 </div>
194<h2><a href="http://www.imagemagick.org/api/MagickCore/resource
195_8c.html" target="source" name="GetMagickResource">GetMagickResource</a></h2>
196<div class="doc-section">
197
198<p>GetMagickResource() returns the specified resource.</p></ol>
199
200<p>The format of the GetMagickResource() method is:</p>
201
202<pre class="code">
203 MagickSizeType GetMagickResource(const ResourceType type)
204</pre>
205
206<p>A description of each parameter follows:</p></ol>
207
208<h5>type</h5>
209<ol><p>the type of resource.</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 limit.</p></ol>
217
218<p>The format of the GetMagickResourceLimit() method is:</p>
219
220<pre class="code">
cristyd75d5d12010-02-16 02:04:50 +0000[diff] [blame]221 MagickSizeType GetMagickResourceLimit(const ResourceType type)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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="ListMagickResourceInfo">ListMagickResourceInfo</a></h2>
232<div class="doc-section">
233
234<p>ListMagickResourceInfo() lists the resource info to a file.</p></ol>
235
236<p>The format of the ListMagickResourceInfo method is:</p>
237
238<pre class="code">
239 MagickBooleanType ListMagickResourceInfo(FILE *file,
240 ExceptionInfo *exception)
241</pre>
242
243<p>A description of each parameter follows.</p></ol>
244
245<h5>file</h5>
246<ol><p>An pointer to a FILE.</p></ol>
247
248<h5>exception</h5>
249<ol><p>return any errors or warnings in this structure.</p></ol>
250
251 </div>
252<h2><a href="http://www.imagemagick.org/api/MagickCore/resource
253_8c.html" target="source" name="RelinquishMagickResource">RelinquishMagickResource</a></h2>
254<div class="doc-section">
255
256<p>RelinquishMagickResource() relinquishes resources of the specified type.</p></ol>
257
258<p>The format of the RelinquishMagickResource() method is:</p>
259
260<pre class="code">
261 void RelinquishMagickResource(const ResourceType type,
262 const MagickSizeType size)
263</pre>
264
265<p>A description of each parameter follows:</p></ol>
266
267<h5>type</h5>
268<ol><p>the type of resource.</p></ol>
269
270<h5>size</h5>
271<ol><p>the size of the resource.</p></ol>
272
273 </div>
274<h2><a href="http://www.imagemagick.org/api/MagickCore/resource
275_8c.html" target="source" name="RelinquishUniqueFileResource">RelinquishUniqueFileResource</a></h2>
276<div class="doc-section">
277
278<p>RelinquishUniqueFileResource() relinquishes a unique file resource.</p></ol>
279
280<p>The format of the RelinquishUniqueFileResource() method is:</p>
281
282<pre class="code">
283 MagickBooleanType RelinquishUniqueFileResource(const char *path)
284</pre>
285
286<p>A description of each parameter follows:</p></ol>
287
288<h5>name</h5>
289<ol><p>the name of the temporary resource.</p></ol>
290
291 </div>
292<h2><a href="http://www.imagemagick.org/api/MagickCore/resource
293_8c.html" target="source" name="SetMagickResourceLimit">SetMagickResourceLimit</a></h2>
294<div class="doc-section">
295
296<p>SetMagickResourceLimit() sets the limit for a particular resource.</p></ol>
297
298<p>The format of the SetMagickResourceLimit() method is:</p>
299
300<pre class="code">
301 MagickBooleanType SetMagickResourceLimit(const ResourceType type,
302 const MagickSizeType limit)
303</pre>
304
305<p>A description of each parameter follows:</p></ol>
306
307<h5>type</h5>
308<ol><p>the type of resource.</p></ol>
309
310<h5>limit</h5>
311<ol><p>the maximum limit for the resource.</p></ol>
312
313 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]314
315</div>
316
317<div id="linkbar">
318 <!-- <span id="linkbar-west">&nbsp;</span> -->
319 <span id="linkbar-center">
320 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristy320dd6e2010-04-16 20:11:40 +0000[diff] [blame]321 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]322 </span>
323 <span id="linkbar-east">&nbsp;</span>
324 </div>
325 <div class="footer">
326 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
327 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
328 </div>
329 <div style="clear: both; margin: 0; width: 100%; "></div>
330</body>
331</html>