Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / c99304fe3c8d9c617da792b40b57c118bb1249af / . / www / api / exception.html
blob: d27c86764ed7c0509b9c1e97ee53188089f33740 [file] [log] [blame]
cristyf3bb4782009-09-08 13:10:04 +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>
cristy1f9e1ed2009-11-18 04:09:38 +0000[diff] [blame]5 <meta http-equiv="Content-Type" value="application/xhtml+xml" />
cristyf3bb4782009-09-08 13:10:04 +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" />
8 <style type="text/css" media="screen,projection"><!--
9 @import url("../../www/magick.css");
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: Dealing with Exceptions</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:, dealing, with, exceptions, 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"/>
cristyf3bb4782009-09-08 13:10:04 +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>
cristyf3bb4782009-09-08 13:10:04 +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>
cristyf3bb4782009-09-08 13:10:04 +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>
cristyf3bb4782009-09-08 13:10:04 +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>
cristyf3bb4782009-09-08 13:10:04 +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>
cristyf3bb4782009-09-08 13:10:04 +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>
cristyf3bb4782009-09-08 13:10:04 +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">
cristy1f9e1ed2009-11-18 04:09:38 +0000[diff] [blame]127 <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
128</div>
129<div class="sponsor">
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]130 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201006010120 Buchhorn -->
cristy2744bd92009-11-08 22:57:52 +0000[diff] [blame]131</div>
132<div class="sponsor">
133 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
cristyc1c61662009-09-30 14:04:37 +0000[diff] [blame]134</div>
135<div class="sponsor">
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]136 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
cristyec678732009-09-22 11:31:10 +0000[diff] [blame]137</div>
138<div class="sponsor">
cristy16ff93c2010-01-13 23:18:07 +0000[diff] [blame]139 <a href="http://www.goyax.de">Börse</a><!-- 201004010240 Gewiese digital-finance.de -->
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]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>
144<div class="sponsor">
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]145 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
146</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]147</div>
148</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]149
150
151</div>
152
153<div class="main">
154
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]155<p class="navigation-index">[<a href="#AcquireExceptionInfo">AcquireExceptionInfo</a> &bull; <a href="#ClearMagickException">ClearMagickException</a> &bull; <a href="#CatchException">CatchException</a> &bull; <a href="#DestroyExceptionInfo">DestroyExceptionInfo</a> &bull; <a href="#GetExceptionInfo">GetExceptionInfo</a> &bull; <a href="#GetExceptionMessage">GetExceptionMessage</a> &bull; <a href="#GetLocaleExceptionMessage">GetLocaleExceptionMessage</a> &bull; <a href="#InheritException">InheritException</a> &bull; <a href="#MagickError">MagickError</a> &bull; <a href="#MagickFatalError">MagickFatalError</a> &bull; <a href="#MagickWarning">MagickWarning</a> &bull; <a href="#SetErrorHandler">SetErrorHandler</a> &bull; <a href="#SetFatalErrorHandler">SetFatalErrorHandler</a> &bull; <a href="#SetWarningHandler">SetWarningHandler</a> &bull; <a href="#ThrowException">ThrowException</a>]</p>
156
157<h2><a href="http://www.imagemagick.org/api/MagickCore/exception
158_8c.html" target="source" name="AcquireExceptionInfo">AcquireExceptionInfo</a></h2>
159<div class="doc-section">
160
161<p>AcquireExceptionInfo() allocates the ExceptionInfo structure.</p></ol>
162
163<p>The format of the AcquireExceptionInfo method is:</p>
164
165<pre class="code">
166 ExceptionInfo *AcquireExceptionInfo(void)
167</pre>
168
169 </div>
170<h2><a href="http://www.imagemagick.org/api/MagickCore/exception
171_8c.html" target="source" name="ClearMagickException">ClearMagickException</a></h2>
172<div class="doc-section">
173
174<p>ClearMagickException() clears any exception that may not have been caught yet.</p></ol>
175
176<p>The format of the ClearMagickException method is:</p>
177
178<pre class="code">
179 ClearMagickException(ExceptionInfo *exception)
180</pre>
181
182<p>A description of each parameter follows:</p></ol>
183
184<h5>exception</h5>
185<ol><p>the exception info.</p></ol>
186
187 </div>
188<h2><a href="http://www.imagemagick.org/api/MagickCore/exception
189_8c.html" target="source" name="CatchException">CatchException</a></h2>
190<div class="doc-section">
191
192<p>CatchException() returns if no exceptions is found otherwise it reports the exception as a warning, error, or fatal depending on the severity.</p></ol>
193
194<p>The format of the CatchException method is:</p>
195
196<pre class="code">
197 CatchException(ExceptionInfo *exception)
198</pre>
199
200<p>A description of each parameter follows:</p></ol>
201
202<h5>exception</h5>
203<ol><p>the exception info.</p></ol>
204
205 </div>
206<h2><a href="http://www.imagemagick.org/api/MagickCore/exception
207_8c.html" target="source" name="DestroyExceptionInfo">DestroyExceptionInfo</a></h2>
208<div class="doc-section">
209
210<p>DestroyExceptionInfo() deallocates memory associated with an exception.</p></ol>
211
212<p>The format of the DestroyExceptionInfo method is:</p>
213
214<pre class="code">
215 ExceptionInfo *DestroyExceptionInfo(ExceptionInfo *exception)
216</pre>
217
218<p>A description of each parameter follows:</p></ol>
219
220<h5>exception</h5>
221<ol><p>the exception info.</p></ol>
222
223 </div>
224<h2><a href="http://www.imagemagick.org/api/MagickCore/exception
225_8c.html" target="source" name="GetExceptionInfo">GetExceptionInfo</a></h2>
226<div class="doc-section">
227
228<p>GetExceptionInfo() initializes an exception to default values.</p></ol>
229
230<p>The format of the GetExceptionInfo method is:</p>
231
232<pre class="code">
233 GetExceptionInfo(ExceptionInfo *exception)
234</pre>
235
236<p>A description of each parameter follows:</p></ol>
237
238<h5>exception</h5>
239<ol><p>the exception info.</p></ol>
240
241 </div>
242<h2><a href="http://www.imagemagick.org/api/MagickCore/exception
243_8c.html" target="source" name="GetExceptionMessage">GetExceptionMessage</a></h2>
244<div class="doc-section">
245
246<p>GetExceptionMessage() returns the error message defined by the specified error code.</p></ol>
247
248<p>The format of the GetExceptionMessage method is:</p>
249
250<pre class="code">
251 char *GetExceptionMessage(const int error)
252</pre>
253
254<p>A description of each parameter follows:</p></ol>
255
256<h5>error</h5>
257<ol><p>the error code.</p></ol>
258
259 </div>
260<h2><a href="http://www.imagemagick.org/api/MagickCore/exception
261_8c.html" target="source" name="GetLocaleExceptionMessage">GetLocaleExceptionMessage</a></h2>
262<div class="doc-section">
263
264<p>GetLocaleExceptionMessage() converts a enumerated exception severity and tag to a message in the current locale.</p></ol>
265
266<p>The format of the GetLocaleExceptionMessage method is:</p>
267
268<pre class="code">
269 const char *GetLocaleExceptionMessage(const ExceptionType severity,
270 const char *tag)
271</pre>
272
273<p>A description of each parameter follows:</p></ol>
274
275<h5>severity</h5>
276<ol><p>the severity of the exception.</p></ol>
277
278<h5>tag</h5>
279<ol><p>the message tag.</p></ol>
280
281 </div>
282<h2><a href="http://www.imagemagick.org/api/MagickCore/exception
283_8c.html" target="source" name="InheritException">InheritException</a></h2>
284<div class="doc-section">
285
286<p>InheritException() inherits an exception from a related exception.</p></ol>
287
288<p>The format of the InheritException method is:</p>
289
290<pre class="code">
291 InheritException(ExceptionInfo *exception,const ExceptionInfo *relative)
292</pre>
293
294<p>A description of each parameter follows:</p></ol>
295
296<h5>exception</h5>
297<ol><p>the exception info.</p></ol>
298
299<h5>relative</h5>
300<ol><p>the related exception info.</p></ol>
301
302 </div>
303<h2><a href="http://www.imagemagick.org/api/MagickCore/exception
304_8c.html" target="source" name="MagickError">MagickError</a></h2>
305<div class="doc-section">
306
307<p>MagickError() calls the exception handler methods with an error reason.</p></ol>
308
309<p>The format of the MagickError method is:</p>
310
311<pre class="code">
312 void MagickError(const ExceptionType error,const char *reason,
313 const char *description)
314</pre>
315
316<p>A description of each parameter follows:</p></ol>
317
318<h5>exception</h5>
319<ol><p>Specifies the numeric error category.</p></ol>
320
321<h5>reason</h5>
322<ol><p>Specifies the reason to display before terminating the program.</p></ol>
323
324<h5>description</h5>
325<ol><p>Specifies any description to the reason.</p></ol>
326
327 </div>
328<h2><a href="http://www.imagemagick.org/api/MagickCore/exception
329_8c.html" target="source" name="MagickFatalError">MagickFatalError</a></h2>
330<div class="doc-section">
331
332<p>MagickFatalError() calls the fatal exception handler methods with an error reason.</p></ol>
333
334<p>The format of the MagickError method is:</p>
335
336<pre class="code">
337 void MagickFatalError(const ExceptionType error,const char *reason,
338 const char *description)
339</pre>
340
341<p>A description of each parameter follows:</p></ol>
342
343<h5>exception</h5>
344<ol><p>Specifies the numeric error category.</p></ol>
345
346<h5>reason</h5>
347<ol><p>Specifies the reason to display before terminating the program.</p></ol>
348
349<h5>description</h5>
350<ol><p>Specifies any description to the reason.</p></ol>
351
352 </div>
353<h2><a href="http://www.imagemagick.org/api/MagickCore/exception
354_8c.html" target="source" name="MagickWarning">MagickWarning</a></h2>
355<div class="doc-section">
356
357<p>MagickWarning() calls the warning handler methods with a warning reason.</p></ol>
358
359<p>The format of the MagickWarning method is:</p>
360
361<pre class="code">
362 void MagickWarning(const ExceptionType warning,const char *reason,
363 const char *description)
364</pre>
365
366<p>A description of each parameter follows:</p></ol>
367
368<h5>warning</h5>
369<ol><p>the warning severity.</p></ol>
370
371<h5>reason</h5>
372<ol><p>Define the reason for the warning.</p></ol>
373
374<h5>description</h5>
375<ol><p>Describe the warning.</p></ol>
376
377 </div>
378<h2><a href="http://www.imagemagick.org/api/MagickCore/exception
379_8c.html" target="source" name="SetErrorHandler">SetErrorHandler</a></h2>
380<div class="doc-section">
381
382<p>SetErrorHandler() sets the exception handler to the specified method and returns the previous exception handler.</p></ol>
383
384<p>The format of the SetErrorHandler method is:</p>
385
386<pre class="code">
387 ErrorHandler SetErrorHandler(ErrorHandler handler)
388</pre>
389
390<p>A description of each parameter follows:</p></ol>
391
392<h5>handler</h5>
393<ol><p>the method to handle errors.</p></ol>
394
395 </div>
396<h2><a href="http://www.imagemagick.org/api/MagickCore/exception
397_8c.html" target="source" name="SetFatalErrorHandler">SetFatalErrorHandler</a></h2>
398<div class="doc-section">
399
400<p>SetFatalErrorHandler() sets the fatal exception handler to the specified method and returns the previous fatal exception handler.</p></ol>
401
402<p>The format of the SetErrorHandler method is:</p>
403
404<pre class="code">
405 ErrorHandler SetErrorHandler(ErrorHandler handler)
406</pre>
407
408<p>A description of each parameter follows:</p></ol>
409
410<h5>handler</h5>
411<ol><p>the method to handle errors.</p></ol>
412
413 </div>
414<h2><a href="http://www.imagemagick.org/api/MagickCore/exception
415_8c.html" target="source" name="SetWarningHandler">SetWarningHandler</a></h2>
416<div class="doc-section">
417
418<p>SetWarningHandler() sets the warning handler to the specified method and returns the previous warning handler.</p></ol>
419
420<p>The format of the SetWarningHandler method is:</p>
421
422<pre class="code">
423 ErrorHandler SetWarningHandler(ErrorHandler handler)
424</pre>
425
426<p>A description of each parameter follows:</p></ol>
427
428<h5>handler</h5>
429<ol><p>the method to handle warnings.</p></ol>
430
431 </div>
432<h2><a href="http://www.imagemagick.org/api/MagickCore/exception
433_8c.html" target="source" name="ThrowException">ThrowException</a></h2>
434<div class="doc-section">
435
436<p>ThrowException() throws an exception with the specified severity code, reason, and optional description.</p></ol>
437
438<p>The format of the ThrowException method is:</p>
439
440<pre class="code">
441 MagickBooleanType ThrowException(ExceptionInfo *exception,
442 const ExceptionType severity,const char *reason,
443 const char *description)
444</pre>
445
446<p>A description of each parameter follows:</p></ol>
447
448<h5>exception</h5>
449<ol><p>the exception info.</p></ol>
450
451<h5>severity</h5>
452<ol><p>the severity of the exception.</p></ol>
453
454<h5>reason</h5>
455<ol><p>the reason for the exception.</p></ol>
456
457<h5>description</h5>
458<ol><p>the exception description.</p></ol>
459
460 </div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]461
462</div>
463
464<div id="linkbar">
465 <!-- <span id="linkbar-west">&nbsp;</span> -->
466 <span id="linkbar-center">
467 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristy7396d882010-01-27 02:37:56 +0000[diff] [blame]468 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]469 </span>
470 <span id="linkbar-east">&nbsp;</span>
471 </div>
472 <div class="footer">
cristy16af1cb2009-12-11 21:38:29 +0000[diff] [blame]473 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]474 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
475 </div>
476 <div style="clear: both; margin: 0; width: 100%; "></div>
477</body>
478</html>