Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 8ee7f2497312da6d76cc514903ec69dbb63d32ea / . / www / api / exception.html
blob: 36b08a9a277a99539d64582f88c4704a711795b3 [file] [log] [blame]
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html version="-//W3C//DTD XHTML 1.1//EN"
4 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
5 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
6 xsi:schemaLocation="http://www.w3.org/1999/xhtml
7 http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
8<head>
9 <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame^]10 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4"/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]11 <title>ImageMagick: MagickCore, C API for ImageMagick: Dealing with Exceptions</title>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]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="application-name" content="ImageMagick"/>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame^]16 <meta name="description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition, resize, rotate, shear, distort or transform images automagically."/>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]17 <meta name="application-url" content="http://www.imagemagick.org"/>
18 <meta name="generator" content="PHP"/>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame^]19 <meta name="keywords" content="magickcore, c, api, for, imagemagick:, dealing, with, exceptions, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"/>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]20 <meta name="rating" content="GENERAL"/>
21 <meta name="robots" content="INDEX, FOLLOW"/>
22 <meta name="generator" content="ImageMagick Studio LLC"/>
23 <meta name="author" content="ImageMagick Studio LLC"/>
24 <meta name="revisit-after" content="2 DAYS"/>
25 <meta name="resource-type" content="document"/>
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]26 <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"/>
cristy751980d2012-06-03 23:18:35 +0000[diff] [blame]27 <meta name="distribution" content="Global"/>
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]28 <link rel="icon" href="../../images/wand.png"/>
29 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]30 <link rel="canonical" href="http://www.imagemagick.org" />
31 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame^]32
33 <!-- Add jQuery library -->
34 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
35
36 <!-- Add mousewheel plugin (this is optional) -->
37 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/lib/jquery.mousewheel-3.0.6.pack.js"></script>
38
39 <!-- Add fancyBox -->
40 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/jquery.fancybox.css?v=2.0.6" type="text/css" media="screen" />
41 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/jquery.fancybox.pack.js?v=2.0.6"></script>
42
43 <!-- Optionally add helpers - button, thumbnail and/or media -->
44 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.css?v=1.0.2" type="text/css" media="screen" />
45 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.js?v=1.0.2"></script>
46 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-media.js?v=1.0.0"></script>
47
48 <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.css?v=2.0.6" type="text/css" media="screen" />
49 <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.js?v=2.0.6"></script>
50
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]51 <script type="text/javascript">
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame^]52 $(document).ready(function() {
53 $(".fancybox").fancybox();
54 });
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]55 </script>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame^]56
57 <!-- ImageMagick style -->
58 <style type="text/css" media="all">
59 @import url("../../www/magick.css");
60 </style>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]61</head>
62
63<body id="www-imagemagick-org">
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame^]64
65<script>
66 (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
67 (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
68 m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
69 })(window,document,'offline-script','//127.0.0.1/analytics.js','ga');
70
71 ga('create', 'UA-40133312-1', 'imagemagick.org');
72 ga('send', 'pageview');
73</script>
74
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]75<div class="titlebar">
76<div style="margin: 17px auto; float: left;">
77 <script type="text/javascript">
78 <!--
79 google_ad_client = "pub-3129977114552745";
80 google_ad_slot = "5439289906";
81 google_ad_width = 728;
82 google_ad_height = 90;
83 //-->
84 </script>
85 <script type="text/javascript"
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame^]86 src="http://127.0.0.1/pagead/show_ads.js">
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]87 </script>
88</div>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame^]89<a href="http://www.imagemagick.org/discourse-server/">
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]90 <img src="../../images/logo.jpg"
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]91 alt="ImageMagick Logo"
92 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame^]93<a href="../../index.html">
cristy72da67d2013-02-24 21:40:48 +0000[diff] [blame]94 <img src="../../images/sprite.jpg"
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]95 alt="ImageMagick Sprite"
96 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
97</div>
98
99<div class="westbar">
100
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]101<div class="menu">
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame^]102 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]104<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]105 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]106</div>
107<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]108 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]109</div>
110<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]111 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]112</div>
113<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]114 <a title="Binary Release: iOS" href="../../www/binary-releases.html#iOS">iOS</a>
cristyda16f162011-02-19 23:52:17 +0000[diff] [blame]115</div>
116<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]117 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]118</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]119<div class="sep"></div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]120<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]121 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]122</div>
123<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]124 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]125</div>
126<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]127 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]128</div>
129<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]130 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]131</div>
132<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]133 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]134</div>
135<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]136 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]137</div>
138<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]139 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]140</div>
141<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]142 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]143</div>
144<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]145 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]146</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]147<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]148<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]149 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]150</div>
151<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]152 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]153</div>
154<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]155 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]156 </div>
157<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]158 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]159</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]160<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]161 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]162</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]163<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]164 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]165</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]166<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]167<div class="menu">
cristy3dfa2192013-02-24 22:46:05 +0000[diff] [blame]168 <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]169</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]170<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]171<div class="menu">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]172 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]173</div>
174<div class="sub">
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]175 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]176</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]177<div class="sep"></div>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame^]178<div class="menu">
179 <a title="Support ImageMagick Development" href="../../www/support.html">Support ImageMagick Development</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]180</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]181</div>
182
183<div class="eastbar">
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]184 <script type="text/javascript">
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame^]185 /* <![CDATA[ */
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]186 (function() {
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame^]187 var po = document.createElement('offline-script'), t = document.getElementsByTagName('offline-script')[0];
188 po.type = 'text/javascript';
189 po.async = true;
190 po.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto';
191 var script = document.getElementsByTagName('offline-script')[0];
192 script.parentNode.insertBefore(po, script);
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]193 })();
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame^]194 /* ]]> */
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]195 </script>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame^]196 <div> <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="http://www.imagemagick.org/"></a></div>
197 <noscript>
198 <a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank">
199 <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" width="93" height="20" border="0" /></a>
200 </noscript>
201 <div class="g-plusone" id="gplusone"></div>
202 <script type="text/javascript">
203 /* <![CDATA[ */
204 window.___gcfg = {
205 lang: 'en-US'
206 };
207
208 (function() {
209 var po = document.createElement('offline-script');
210 po.type = 'text/javascript';
211 po.async = true;
212 po.src = 'https://127.0.0.1/js/plusone.js';
213 var script = document.getElementsByTagName('offline-script')[0];
214 script.parentNode.insertBefore(po, script);
215 })();
216 var gplusone = document.getElementById("gplusone");
217 gplusone.setAttribute("data-size","medium");
218 gplusone.setAttribute("data-count","true");
219 /* ]]> */
220 </script>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]221</div>
222
223<div class="main">
224
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]225<h1>Module exception Methods</h1>
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]226<p class="navigation-index">[<a href="exception.html#AcquireExceptionInfo">AcquireExceptionInfo</a> &bull; <a href="exception.html#ClearMagickException">ClearMagickException</a> &bull; <a href="exception.html#CatchException">CatchException</a> &bull; <a href="exception.html#DestroyExceptionInfo">DestroyExceptionInfo</a> &bull; <a href="exception.html#GetExceptionInfo">GetExceptionInfo</a> &bull; <a href="exception.html#GetExceptionMessage">GetExceptionMessage</a> &bull; <a href="exception.html#GetLocaleExceptionMessage">GetLocaleExceptionMessage</a> &bull; <a href="exception.html#InheritException">InheritException</a> &bull; <a href="exception.html#MagickError">MagickError</a> &bull; <a href="exception.html#MagickFatalError">MagickFatalError</a> &bull; <a href="exception.html#MagickWarning">MagickWarning</a> &bull; <a href="exception.html#SetErrorHandler">SetErrorHandler</a> &bull; <a href="exception.html#SetFatalErrorHandler">SetFatalErrorHandler</a> &bull; <a href="exception.html#SetWarningHandler">SetWarningHandler</a> &bull; <a href="exception.html#ThrowException">ThrowException</a>]</p>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]227
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]228<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="AcquireExceptionInfo">AcquireExceptionInfo</a></h2>
229<div class="doc-section">
230
231<p>AcquireExceptionInfo() allocates the ExceptionInfo structure.</p>
232
233<p>The format of the AcquireExceptionInfo method is:</p>
234
235<pre class="code">
236 ExceptionInfo *AcquireExceptionInfo(void)
237</pre>
238
239 </div>
240<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="ClearMagickException">ClearMagickException</a></h2>
241<div class="doc-section">
242
243<p>ClearMagickException() clears any exception that may not have been caught yet.</p>
244
245<p>The format of the ClearMagickException method is:</p>
246
247<pre class="code">
248 ClearMagickException(ExceptionInfo *exception)
249</pre>
250
251<p>A description of each parameter follows:</p>
252
253<h5>exception</h5>
254<p>the exception info.</p>
255
256 </div>
257<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="CatchException">CatchException</a></h2>
258<div class="doc-section">
259
260<p>CatchException() returns if no exceptions is found otherwise it reports the exception as a warning, error, or fatal depending on the severity.</p>
261
262<p>The format of the CatchException method is:</p>
263
264<pre class="code">
265 CatchException(ExceptionInfo *exception)
266</pre>
267
268<p>A description of each parameter follows:</p>
269
270<h5>exception</h5>
271<p>the exception info.</p>
272
273 </div>
274<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="DestroyExceptionInfo">DestroyExceptionInfo</a></h2>
275<div class="doc-section">
276
277<p>DestroyExceptionInfo() deallocates memory associated with an exception.</p>
278
279<p>The format of the DestroyExceptionInfo method is:</p>
280
281<pre class="code">
282 ExceptionInfo *DestroyExceptionInfo(ExceptionInfo *exception)
283</pre>
284
285<p>A description of each parameter follows:</p>
286
287<h5>exception</h5>
288<p>the exception info.</p>
289
290 </div>
291<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="GetExceptionInfo">GetExceptionInfo</a></h2>
292<div class="doc-section">
293
294<p>GetExceptionInfo() initializes an exception to default values.</p>
295
296<p>The format of the GetExceptionInfo method is:</p>
297
298<pre class="code">
299 GetExceptionInfo(ExceptionInfo *exception)
300</pre>
301
302<p>A description of each parameter follows:</p>
303
304<h5>exception</h5>
305<p>the exception info.</p>
306
307 </div>
308<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="GetExceptionMessage">GetExceptionMessage</a></h2>
309<div class="doc-section">
310
311<p>GetExceptionMessage() returns the error message defined by the specified error code.</p>
312
313<p>The format of the GetExceptionMessage method is:</p>
314
315<pre class="code">
316 char *GetExceptionMessage(const int error)
317</pre>
318
319<p>A description of each parameter follows:</p>
320
321<h5>error</h5>
322<p>the error code.</p>
323
324 </div>
325<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="GetLocaleExceptionMessage">GetLocaleExceptionMessage</a></h2>
326<div class="doc-section">
327
328<p>GetLocaleExceptionMessage() converts a enumerated exception severity and tag to a message in the current locale.</p>
329
330<p>The format of the GetLocaleExceptionMessage method is:</p>
331
332<pre class="code">
333 const char *GetLocaleExceptionMessage(const ExceptionType severity,
334 const char *tag)
335</pre>
336
337<p>A description of each parameter follows:</p>
338
339<h5>severity</h5>
340<p>the severity of the exception.</p>
341
342<h5>tag</h5>
343<p>the message tag.</p>
344
345 </div>
346<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="InheritException">InheritException</a></h2>
347<div class="doc-section">
348
349<p>InheritException() inherits an exception from a related exception.</p>
350
351<p>The format of the InheritException method is:</p>
352
353<pre class="code">
354 InheritException(ExceptionInfo *exception,const ExceptionInfo *relative)
355</pre>
356
357<p>A description of each parameter follows:</p>
358
359<h5>exception</h5>
360<p>the exception info.</p>
361
362<h5>relative</h5>
363<p>the related exception info.</p>
364
365 </div>
366<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="MagickError">MagickError</a></h2>
367<div class="doc-section">
368
369<p>MagickError() calls the exception handler methods with an error reason.</p>
370
371<p>The format of the MagickError method is:</p>
372
373<pre class="code">
374 void MagickError(const ExceptionType error,const char *reason,
375 const char *description)
376</pre>
377
378<p>A description of each parameter follows:</p>
379
380<h5>exception</h5>
381<p>Specifies the numeric error category.</p>
382
383<h5>reason</h5>
384<p>Specifies the reason to display before terminating the program.</p>
385
386<h5>description</h5>
387<p>Specifies any description to the reason.</p>
388
389 </div>
390<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="MagickFatalError">MagickFatalError</a></h2>
391<div class="doc-section">
392
393<p>MagickFatalError() calls the fatal exception handler methods with an error reason.</p>
394
395<p>The format of the MagickError method is:</p>
396
397<pre class="code">
398 void MagickFatalError(const ExceptionType error,const char *reason,
399 const char *description)
400</pre>
401
402<p>A description of each parameter follows:</p>
403
404<h5>exception</h5>
405<p>Specifies the numeric error category.</p>
406
407<h5>reason</h5>
408<p>Specifies the reason to display before terminating the program.</p>
409
410<h5>description</h5>
411<p>Specifies any description to the reason.</p>
412
413 </div>
414<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="MagickWarning">MagickWarning</a></h2>
415<div class="doc-section">
416
417<p>MagickWarning() calls the warning handler methods with a warning reason.</p>
418
419<p>The format of the MagickWarning method is:</p>
420
421<pre class="code">
422 void MagickWarning(const ExceptionType warning,const char *reason,
423 const char *description)
424</pre>
425
426<p>A description of each parameter follows:</p>
427
428<h5>warning</h5>
429<p>the warning severity.</p>
430
431<h5>reason</h5>
432<p>Define the reason for the warning.</p>
433
434<h5>description</h5>
435<p>Describe the warning.</p>
436
437 </div>
438<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="SetErrorHandler">SetErrorHandler</a></h2>
439<div class="doc-section">
440
441<p>SetErrorHandler() sets the exception handler to the specified method and returns the previous exception handler.</p>
442
443<p>The format of the SetErrorHandler method is:</p>
444
445<pre class="code">
446 ErrorHandler SetErrorHandler(ErrorHandler handler)
447</pre>
448
449<p>A description of each parameter follows:</p>
450
451<h5>handler</h5>
452<p>the method to handle errors.</p>
453
454 </div>
455<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="SetFatalErrorHandler">SetFatalErrorHandler</a></h2>
456<div class="doc-section">
457
458<p>SetFatalErrorHandler() sets the fatal exception handler to the specified method and returns the previous fatal exception handler.</p>
459
460<p>The format of the SetErrorHandler method is:</p>
461
462<pre class="code">
463 ErrorHandler SetErrorHandler(ErrorHandler handler)
464</pre>
465
466<p>A description of each parameter follows:</p>
467
468<h5>handler</h5>
469<p>the method to handle errors.</p>
470
471 </div>
472<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="SetWarningHandler">SetWarningHandler</a></h2>
473<div class="doc-section">
474
475<p>SetWarningHandler() sets the warning handler to the specified method and returns the previous warning handler.</p>
476
477<p>The format of the SetWarningHandler method is:</p>
478
479<pre class="code">
480 ErrorHandler SetWarningHandler(ErrorHandler handler)
481</pre>
482
483<p>A description of each parameter follows:</p>
484
485<h5>handler</h5>
486<p>the method to handle warnings.</p>
487
488 </div>
489<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="ThrowException">ThrowException</a></h2>
490<div class="doc-section">
491
492<p>ThrowException() throws an exception with the specified severity code, reason, and optional description.</p>
493
494<p>The format of the ThrowException method is:</p>
495
496<pre class="code">
497 MagickBooleanType ThrowException(ExceptionInfo *exception,
498 const ExceptionType severity,const char *reason,
499 const char *description)
500</pre>
501
502<p>A description of each parameter follows:</p>
503
504<h5>exception</h5>
505<p>the exception info.</p>
506
507<h5>severity</h5>
508<p>the severity of the exception.</p>
509
510<h5>reason</h5>
511<p>the reason for the exception.</p>
512
513<h5>description</h5>
514<p>the exception description.</p>
515
516 </div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]517
518</div>
519
520<div id="linkbar">
521 <span id="linkbar-west">&nbsp;</span>
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame^]522
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]523 <span id="linkbar-center">
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame^]524 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
525 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a> &bull;
526 <a href="http://jqmagick.imagemagick.org/">JqMagick</a>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]527 </span>
528 <span id="linkbar-east">&nbsp;</span>
529 </div>
530 <div class="footer">
cristy8ee7f242013-06-20 16:08:44 +0000[diff] [blame^]531 <span id="footer-west">&copy; 1999-2013 ImageMagick Studio LLC</span>
cristyd8833bf2013-02-24 22:14:53 +0000[diff] [blame]532 <span id="footer-east"> <a href="../../www/contact.html">Contact the Wizards</a></span>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]533 </div>
534 <div style="clear: both; margin: 0; width: 100%; "></div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]535</body>
536</html>