Debian Codegraph @

www/api/resource.html

raw ◀ ▶
Source reconstructed at patch state 0 of 4 — not the installed (fully patched) source.
4 Debian patches touch this file
1
2
3
4
5 <!doctype html>
6 <html lang="en" data-bs-theme="dark">
7 <head>
8 <script src="../assets/color-modes.js" ></script>
9 <meta charset="utf-8" />
10 <meta name="viewport" content="width=device-width, initial-scale=1" />
11 <title>ImageMagick – MagickCore, C API: Monitor or Limit Resource Consumption</title>
12 <meta name="keywords" content="MagickCore, C API: Monitor or Limit Resource Consumption, Image Processing, Digital Image Editing, Image Conversion, Open-Source Software, Image Manipulation, Command-Line Image Tools" />
13 <meta name="description" content="ImageMagick is a powerful, open-source software suite for creating, editing, converting, and manipulating images in over 200 formats. Ideal for web developers, graphic designers, and researchers, it offers versatile tools for image processing, including batch processing, format conversion, and complex image transformations." />
14 <meta name="application-name" content="ImageMagick" />
15 <meta name="application-url" content="https://imagemagick.org" />
16 <meta name="copyright" content="Copyright (c) 1999 ImageMagick Studio LLC" />
17 <meta itemprop='url' content='../../' />
18 <meta itemprop='title' content='ImageMagick' />
19 <meta itemprop='description' content="ImageMagick is a powerful, open-source software suite for creating, editing, converting, and manipulating images in over 200 formats. Ideal for web developers, graphic designers, and researchers, it offers versatile tools for image processing, including batch processing, format conversion, and complex image transformations." />
20 <meta property='og:url' content='../../' />
21 <meta property='og:name' content='ImageMagick' />
22 <meta property='og:image' content='../../../../../../../../images/logo.png' />
23 <meta property='og:type' content='website' />
24 <meta property='og:site_name' content='ImageMagick' />
25 <meta property='og:description' content="ImageMagick is a powerful, open-source software suite for creating, editing, converting, and manipulating images in over 200 formats. Ideal for web developers, graphic designers, and researchers, it offers versatile tools for image processing, including batch processing, format conversion, and complex image transformations." />
26 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
27 <link type="images/png" sizes="64x64" href="../../../../../../../images/wand.png" rel="icon" />
28 <link type="images/icon" sizes="16x16" href="../../../../../../../images/wand.ico" rel="shortcut icon" />
29 <link href="resource.html" rel="canonical" />
30 <link href="../assets/bootstrap.min.css" rel="stylesheet" />
31 </head>
32 <body>
33 <svg xmlns="http://www.w3.org/2000/svg" class="d-none">
34 <symbol id="check2" viewBox="0 0 16 16">
35 <path d="M13.854 3.646a.5.5 0 0 1 0 .708l-7 7a.5.5 0 0 1-.708 0l-3.5-3.5a.5.5 0 1 1 .708-.708L6.5 10.293l6.646-6.647a.5.5 0 0 1 .708 0z"/>
36 </symbol>
37 <symbol id="circle-half" viewBox="0 0 16 16">
38 <path d="M8 15A7 7 0 1 0 8 1v14zm0 1A8 8 0 1 1 8 0a8 8 0 0 1 0 16z"/>
39 </symbol>
40 <symbol id="moon-stars-fill" viewBox="0 0 16 16">
41 <path d="M6 .278a.768.768 0 0 1 .08.858 7.208 7.208 0 0 0-.878 3.46c0 4.021 3.278 7.277 7.318 7.277.527 0 1.04-.055 1.533-.16a.787.787 0 0 1 .81.316.733.733 0 0 1-.031.893A8.349 8.349 0 0 1 8.344 16C3.734 16 0 12.286 0 7.71 0 4.266 2.114 1.312 5.124.06A.752.752 0 0 1 6 .278z"/>
42 <path d="M10.794 3.148a.217.217 0 0 1 .412 0l.387 1.162c.173.518.579.924 1.097 1.097l1.162.387a.217.217 0 0 1 0 .412l-1.162.387a1.734 1.734 0 0 0-1.097 1.097l-.387 1.162a.217.217 0 0 1-.412 0l-.387-1.162A1.734 1.734 0 0 0 9.31 6.593l-1.162-.387a.217.217 0 0 1 0-.412l1.162-.387a1.734 1.734 0 0 0 1.097-1.097l.387-1.162zM13.863.099a.145.145 0 0 1 .274 0l.258.774c.115.346.386.617.732.732l.774.258a.145.145 0 0 1 0 .274l-.774.258a1.156 1.156 0 0 0-.732.732l-.258.774a.145.145 0 0 1-.274 0l-.258-.774a1.156 1.156 0 0 0-.732-.732l-.774-.258a.145.145 0 0 1 0-.274l.774-.258c.346-.115.617-.386.732-.732L13.863.1z"/>
43 </symbol>
44 <symbol id="sun-fill" viewBox="0 0 16 16">
45 <path d="M8 12a4 4 0 1 0 0-8 4 4 0 0 0 0 8zM8 0a.5.5 0 0 1 .5.5v2a.5.5 0 0 1-1 0v-2A.5.5 0 0 1 8 0zm0 13a.5.5 0 0 1 .5.5v2a.5.5 0 0 1-1 0v-2A.5.5 0 0 1 8 13zm8-5a.5.5 0 0 1-.5.5h-2a.5.5 0 0 1 0-1h2a.5.5 0 0 1 .5.5zM3 8a.5.5 0 0 1-.5.5h-2a.5.5 0 0 1 0-1h2A.5.5 0 0 1 3 8zm10.657-5.657a.5.5 0 0 1 0 .707l-1.414 1.415a.5.5 0 1 1-.707-.708l1.414-1.414a.5.5 0 0 1 .707 0zm-9.193 9.193a.5.5 0 0 1 0 .707L3.05 13.657a.5.5 0 0 1-.707-.707l1.414-1.414a.5.5 0 0 1 .707 0zm9.193 2.121a.5.5 0 0 1-.707 0l-1.414-1.414a.5.5 0 0 1 .707-.707l1.414 1.414a.5.5 0 0 1 0 .707zM4.464 4.465a.5.5 0 0 1-.707 0L2.343 3.05a.5.5 0 1 1 .707-.707l1.414 1.414a.5.5 0 0 1 0 .708z"/>
46 </symbol>
47 </svg>
48 <div class="dropdown position-fixed bottom-0 end-0 mb-3 me-3 bd-mode-toggle">
49 <button class="btn btn-bd-secondary py-2 dropdown-toggle d-flex align-items-center"
50 id="bd-theme"
51 type="button"
52 aria-expanded="false"
53 data-bs-toggle="dropdown"
54 aria-label="Toggle theme (auto)">
55 <svg class="bi my-1 theme-icon-active" width="1em" height="1em"><use href="#circle-half"></use></svg>
56 <span class="visually-hidden" id="bd-theme-text">Toggle theme</span>
57 </button>
58 <ul class="dropdown-menu dropdown-menu-end shadow" aria-labelledby="bd-theme-text">
59 <li>
60 <button type="button" class="dropdown-item d-flex align-items-center" data-bs-theme-value="light" aria-pressed="false">
61 <svg class="bi me-2 opacity-50" width="1em" height="1em"><use href="#sun-fill"></use></svg>
62 Light
63 <svg class="bi ms-auto d-none" width="1em" height="1em"><use href="#check2"></use></svg>
64 </button>
65 </li>
66 <li>
67 <button type="button" class="dropdown-item d-flex align-items-center active" data-bs-theme-value="dark" aria-pressed="false">
68 <svg class="bi me-2 opacity-50" width="1em" height="1em"><use href="#moon-stars-fill"></use></svg>
69 Dark
70 <svg class="bi ms-auto d-none" width="1em" height="1em"><use href="#check2"></use></svg>
71 </button>
72 </li>
73 <li>
74 <button type="button" class="dropdown-item d-flex align-items-center" data-bs-theme-value="auto" aria-pressed="true">
75 <svg class="bi me-2 opacity-50" width="1em" height="1em"><use href="#circle-half"></use></svg>
76 Auto
77 <svg class="bi ms-auto d-none" width="1em" height="1em"><use href="#check2"></use></svg>
78 </button>
79 </li>
80 </ul>
81 </div>
82 <svg xmlns="http://www.w3.org/2000/svg" class="d-none">
83 <symbol id="arrow-right-circle" viewBox="0 0 16 16">
84 <path d="M8 0a8 8 0 1 1 0 16A8 8 0 0 1 8 0zM4.5 7.5a.5.5 0 0 0 0 1h5.793l-2.147 2.146a.5.5 0 0 0 .708.708l3-3a.5.5 0 0 0 0-.708l-3-3a.5.5 0 1 0-.708.708L10.293 7.5H4.5z"/>
85 </symbol>
86 <symbol id="color-mode" viewBox="0 0 118 94">
87 <title>Color Modes</title>
88 <path fill-rule="evenodd" clip-rule="evenodd" d="M24.509 0c-6.733 0-11.715 5.893-11.492 12.284.214 6.14-.064 14.092-2.066 20.577C8.943 39.365 5.547 43.485 0 44.014v5.972c5.547.529 8.943 4.649 10.951 11.153 2.002 6.485 2.28 14.437 2.066 20.577C12.794 88.106 17.776 94 24.51 94H93.5c6.733 0 11.714-5.893 11.491-12.284-.214-6.14.064-14.092 2.066-20.577 2.009-6.504 5.396-10.624 10.943-11.153v-5.972c-5.547-.529-8.934-4.649-10.943-11.153-2.002-6.484-2.28-14.437-2.066-20.577C105.214 5.894 100.233 0 93.5 0H24.508zM80 57.863C80 66.663 73.436 72 62.543 72H44a2 2 0 01-2-2V24a2 2 0 012-2h18.437c9.083 0 15.044 4.92 15.044 12.474 0 5.302-4.01 10.049-9.119 10.88v.277C75.317 46.394 80 51.21 80 57.863zM60.521 28.34H49.948v14.934h8.905c6.884 0 10.68-2.772 10.68-7.727 0-4.643-3.264-7.207-9.012-7.207zM49.948 49.2v16.458H60.91c7.167 0 10.964-2.876 10.964-8.281 0-5.406-3.903-8.178-11.425-8.178H49.948z"></path>
89 </symbol>
90 </svg>
91 <nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top">
92 <div class="container-fluid">
93 <a class="navbar-brand" href="../index.html"><img class="d-block" id="icon" alt="ImageMagick" width="32" height="32" src="../../../../../../../images/wand.ico"/></a>
94 <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#magick-navbars" aria-controls="magick-navbars" aria-expanded="false" aria-label="Toggle navigation">
95 <span class="navbar-toggler-icon"></span>
96 </button>
97
98 <div class="collapse navbar-collapse" id="magick-navbars">
99 <ul class="navbar-nav me-auto mb-2 mb-md-0">
100 <li class="nav-item">
101 <a class="nav-link " href="../www/download.html">Download</a>
102 </li>
103 <li class="nav-item">
104 <a class="nav-link " href="../www/command-line-tools.html">Tools</a>
105 </li>
106 <li class="nav-item">
107 <a class="nav-link " href="../www/command-line-processing.html">CLI</a>
108 </li>
109 <li class="nav-item">
110 <a class="nav-link " href="../www/develop.html">Develop</a>
111 </li>
112 <li class="nav-item">
113 <a class="nav-link" target="_blank" href="https://github.com/ImageMagick/ImageMagick/discussions">Community</a>
114 </li>
115 <li class="nav-item">
116 <iframe src="https://github.com/sponsors/ImageMagick/button" title="Sponsor ImageMagick" height="35" width="107" style="border: 0;"></iframe>
117 </li>
118 </ul>
119 <form class="d-flex form-inline" action="../../../../../https://imagemagick.org/script/search.php">
120 <input class="form-control me-2" type="text" name="q" placeholder="Search" aria-label="Search">
121 <button class="btn btn-outline-success" type="submit" name="sa">Search</button>
122 </form>
123 </div>
124 </div>
125 </nav>
126
127 <div class="col-lg-8 mx-auto p-4 py-md-5 text-body-secondary">
128 <header class="d-flex align-items-center pb-3 mb-5 border-bottom">
129 <a href="../index.html" class="d-flex align-items-center text-decoration-none">
130 <h1 class="mt-5 fs-3">MagickCore, C API: Monitor or Limit Resource Consumption</h1>
131 </a>
132 </header>
133
134 <main class="container">
135 <h1 class="text-center">Resource</h1>
136 <div class="btn-group">
137 <button class="btn btn-secondary dropdown-toggle" type="button" id="defaultDropdown" data-bs-toggle="dropdown" data-bs-auto-close="true" aria-expanded="false">
138 Select API Method
139 </button>
140 <ul class="dropdown-menu pre-scrollable" aria-labelledby="defaultDropdown">
141 <li><a href="#AcquireMagickResource">AcquireMagickResource</a></li>
142 <li><a href="#AcquireUniqueFileResource">AcquireUniqueFileResource</a></li>
143 <li><a href="#GetMagickResource">GetMagickResource</a></li>
144 <li><a href="#GetMagickResourceLimit">GetMagickResourceLimit</a></li>
145 <li><a href="#ListMagickResourceInfo">ListMagickResourceInfo</a></li>
146 <li><a href="#RelinquishMagickResource">RelinquishMagickResource</a></li>
147 <li><a href="#RelinquishUniqueFileResource">RelinquishUniqueFileResource</a></li>
148 </ul>
149 </div>
150 <br/>
151 <br/>
152 <div class="magick-header">
153 <h2><a href="../../api/MagickCore/resource_8c.html" id="AcquireMagickResource">AcquireMagickResource</a></h2>
154
155 <p>AcquireMagickResource() acquires resources of the specified type. MagickFalse is returned if the specified resource is exhausted otherwise MagickTrue.</p>
156
157 <p>The format of the AcquireMagickResource() method is:</p>
158
159 <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType AcquireMagickResource(const ResourceType type,
160 const MagickSizeType size)
161 </samp></pre>
162
163 <p>A description of each parameter follows:</p>
164
165 <dd>
166 </dd>
167
168 <dd> </dd>
169 <dl class="dl-horizontal">
170 <dt>type</dt>
171 <dd>the type of resource. </dd>
172
173 <dd> </dd>
174 <dt>size</dt>
175 <dd>the number of bytes needed from for this resource. </dd>
176
177 <dd> </dd>
178 </dl>
179 <h2><a href="../../api/MagickCore/resource_8c.html" id="AcquireUniqueFileResource">AcquireUniqueFileResource</a></h2>
180
181 <p>AcquireUniqueFileResource() returns a unique file name, and returns a file descriptor for the file open for reading and writing.</p>
182
183 <p>The format of the AcquireUniqueFileResource() method is:</p>
184
185 <pre class="bg-light text-dark mx-4"><samp>int AcquireUniqueFileResource(char *path)
186 </samp></pre>
187
188 <p>A description of each parameter follows:</p>
189
190 <dd>
191 </dd>
192
193 <dd> </dd>
194 <dl class="dl-horizontal">
195 <dt> path</dt>
196 <dd> Specifies a pointer to an array of characters. The unique path name is returned in this array. </dd>
197
198 <dd> </dd>
199 </dl>
200 <h2><a href="../../api/MagickCore/resource_8c.html" id="GetMagickResource">GetMagickResource</a></h2>
201
202 <p>GetMagickResource() returns the specified resource.</p>
203
204 <p>The format of the GetMagickResource() method is:</p>
205
206 <pre class="bg-light text-dark mx-4"><samp>MagickSizeType GetMagickResource(const ResourceType type)
207 </samp></pre>
208
209 <p>A description of each parameter follows:</p>
210
211 <dd>
212 </dd>
213
214 <dd> </dd>
215 <dl class="dl-horizontal">
216 <dt>type</dt>
217 <dd>the type of resource. </dd>
218
219 <dd> </dd>
220 </dl>
221 <h2><a href="../../api/MagickCore/resource_8c.html" id="GetMagickResourceLimit">GetMagickResourceLimit</a></h2>
222
223 <p>GetMagickResourceLimit() returns the specified resource limit.</p>
224
225 <p>The format of the GetMagickResourceLimit() method is:</p>
226
227 <pre class="bg-light text-dark mx-4"><samp>MagickSizeType GetMagickResourceLimit(const ResourceType type)
228 </samp></pre>
229
230 <p>A description of each parameter follows:</p>
231
232 <dd>
233 </dd>
234
235 <dd> </dd>
236 <dl class="dl-horizontal">
237 <dt>type</dt>
238 <dd>the type of resource. </dd>
239
240 <dd> </dd>
241 </dl>
242 <h2><a href="../../api/MagickCore/resource_8c.html" id="ListMagickResourceInfo">ListMagickResourceInfo</a></h2>
243
244 <p>ListMagickResourceInfo() lists the resource info to a file.</p>
245
246 <p>The format of the ListMagickResourceInfo method is:</p>
247
248 <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType ListMagickResourceInfo(FILE *file,
249 ExceptionInfo *exception)
250 </samp></pre>
251
252 <p>A description of each parameter follows.</p>
253
254 <dt>file</dt>
255 <p>An pointer to a FILE.</p>
256
257 <dt>exception</dt>
258 <p>return any errors or warnings in this structure.</p>
259
260 <h2><a href="../../api/MagickCore/resource_8c.html" id="RelinquishMagickResource">RelinquishMagickResource</a></h2>
261
262 <p>RelinquishMagickResource() relinquishes resources of the specified type.</p>
263
264 <p>The format of the RelinquishMagickResource() method is:</p>
265
266 <pre class="bg-light text-dark mx-4"><samp>void RelinquishMagickResource(const ResourceType type,
267 const MagickSizeType size)
268 </samp></pre>
269
270 <p>A description of each parameter follows:</p>
271
272 <dd>
273 </dd>
274
275 <dd> </dd>
276 <dl class="dl-horizontal">
277 <dt>type</dt>
278 <dd>the type of resource. </dd>
279
280 <dd> </dd>
281 <dt>size</dt>
282 <dd>the size of the resource. </dd>
283
284 <dd> </dd>
285 </dl>
286 <h2><a href="../../api/MagickCore/resource_8c.html" id="RelinquishUniqueFileResource">RelinquishUniqueFileResource</a></h2>
287
288 <p>RelinquishUniqueFileResource() relinquishes a unique file resource.</p>
289
290 <p>The format of the RelinquishUniqueFileResource() method is:</p>
291
292 <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType RelinquishUniqueFileResource(const char *path)
293 </samp></pre>
294
295 <p>A description of each parameter follows:</p>
296
297 <dd>
298 </dd>
299
300 <dd> </dd>
301 <dl class="dl-horizontal">
302 <dt>name</dt>
303 <dd>the name of the temporary resource. </dd>
304
305 <dd> </dd>
306 </dl>
307 <h2><a href="../../api/MagickCore/resource_8c.html" id="SetMagickResourceLimit">SetMagickResourceLimit</a></h2>
308
309 <p>SetMagickResourceLimit() sets the limit for a particular resource.</p>
310
311 <p>The format of the SetMagickResourceLimit() method is:</p>
312
313 <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType SetMagickResourceLimit(const ResourceType type,
314 const MagickSizeType limit)
315 </samp></pre>
316
317 <p>A description of each parameter follows:</p>
318
319 <dd>
320 </dd>
321
322 <dd> </dd>
323 <dl class="dl-horizontal">
324 <dt>type</dt>
325 <dd>the type of resource. </dd>
326
327 <dd> </dd>
328 <dt>limit</dt>
329 <dd>the maximum limit for the resource. </dd>
330
331 <dd> </dd>
332 </dl>
333 </div>
334 </div>
335 </main><!-- /.container -->
336 <footer class="py-5 text-center text-body-secondary bg-body-tertiary">
337 <div class="container-fluid">
338 <a href="../www/security-policy.html">Security</a> •
339 <a href="../www/news.html">News</a>
340
341 <a href="#"><img class="d-inline" id="wand" alt="And Now a Touch of Magick" width="16" height="16" src="../../../../../../../images/wand.ico"/></a>
342
343 <a href="../www/links.html">Related</a> •
344 <a href="../www/sitemap.html">Sitemap</a>
345 <br/>
346 <a href="../www/support.html">Sponsor</a> •
347 <a href="../www/cite.html">Cite</a> •
348 <a href="http://pgp.mit.edu/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
349 <a href="../www/contact.html">Contact Us</a>
350 <br/>
351 <a href="https://github.com/imagemagick/imagemagick" target="_blank" rel="noopener" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 512 499.36" width="2%" height="2%" role="img" focusable="false"><title>GitHub</title><path fill="currentColor" fill-rule="evenodd" d="M256 0C114.64 0 0 114.61 0 256c0 113.09 73.34 209 175.08 242.9 12.8 2.35 17.47-5.56 17.47-12.34 0-6.08-.22-22.18-.35-43.54-71.2 15.49-86.2-34.34-86.2-34.34-11.64-29.57-28.42-37.45-28.42-37.45-23.27-15.84 1.73-15.55 1.73-15.55 25.69 1.81 39.21 26.38 39.21 26.38 22.84 39.12 59.92 27.82 74.5 21.27 2.33-16.54 8.94-27.82 16.25-34.22-56.84-6.43-116.6-28.43-116.6-126.49 0-27.95 10-50.8 26.35-68.69-2.63-6.48-11.42-32.5 2.51-67.75 0 0 21.49-6.88 70.4 26.24a242.65 242.65 0 0 1 128.18 0c48.87-33.13 70.33-26.24 70.33-26.24 14 35.25 5.18 61.27 2.55 67.75 16.41 17.9 26.31 40.75 26.31 68.69 0 98.35-59.85 120-116.88 126.32 9.19 7.9 17.38 23.53 17.38 47.41 0 34.22-.31 61.83-.31 70.23 0 6.85 4.61 14.81 17.6 12.31C438.72 464.97 512 369.08 512 256.02 512 114.62 397.37 0 256 0z"/></svg></a> •
352 <a href="https://twitter.com/imagemagick" target="_blank" rel="noopener" aria-label="Twitter"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 300 300" width="2%" height="2%" role="img" focusable="false"><title>Twitter</title><path d="M178.57 127.15 290.27 0h-26.46l-97.03 110.38L89.34 0H0l117.13 166.93L0 300.25h26.46l102.4-116.59 81.8 116.59h89.34M36.01 19.54H76.66l187.13 262.13h-40.66"/></svg></a>
353 <br/>
354 <small>Copyright © 1999 ImageMagick Studio LLC</small>
355 </div>
356 </footer>
357 </div>
358
359 <!-- Javascript assets -->
360 <script src="../assets/bootstrap.bundle.min.js" ></script>
361 </body>
362 </html>