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