Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / e6e8415823c09ed129e481e0a3bc678324b38c99 / . / www / api / exception.html
blob: 4b8c22ef459c3db94d5bd1b6718429ed5d2d44e2 [file] [log] [blame]
cristydcca3fa2010-12-29 21: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">
cristy2bd2a982011-02-15 00:52:58 +0000[diff] [blame]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">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]8<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]9 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
10 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]11 <title>ImageMagick: MagickCore, C API for ImageMagick: Dealing with Exceptions</title>
cristy3ed852e2009-09-05 21:47:34 +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"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]15 <meta name="Application-name" content="ImageMagick"/>
cristye6e84152011-06-06 14:16:49 +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 and transform images automagically."/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]17 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]18 <meta name="Generator" content="PHP"/>
cristye6e84152011-06-06 14:16:49 +0000[diff] [blame^]19 <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, Image, Processing, Automagically"/>
cristy3ed852e2009-09-05 21:47:34 +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"/>
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]26 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]27 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]28 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]29 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
30 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]31 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]32 <style type="text/css" media="all">
33 @import url("../../www/magick.css");
34 </style>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]35 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +0000[diff] [blame]36 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
37 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
38 <script type="text/javascript">
39 $(document).ready(function() {
40 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
41 'transitionIn' : 'elastic',
42 'transitionOut' : 'elastic',
43 'overlayShow' : false,
44 'opacity' : true
45 });
46 });
47 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]48</head>
49
50<body id="www-imagemagick-org">
51<div class="titlebar">
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]52<div style="margin: 17px auto; float: left;">
53 <script type="text/javascript">
54 <!--
55 google_ad_client = "pub-3129977114552745";
56 google_ad_slot = "5439289906";
57 google_ad_width = 728;
58 google_ad_height = 90;
59 //-->
60 </script>
61 <script type="text/javascript"
62 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
63 </script>
64</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]65<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]66 <img src="../../images/logo.jpg"
67 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]68 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]69<a href="../../index.html">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]70 <img src="../../images/sprite.jpg"
71 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]72 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
73</div>
74
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]75<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]76
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]77<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]78 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]79</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]80<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]81<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]82 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
83</div>
84<div class="sub">
85 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
86</div>
87<div class="sub">
88 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
89</div>
90<div class="sub">
cristye6e84152011-06-06 14:16:49 +0000[diff] [blame^]91 <a title="Binary Release: iOS" href="../../www/binary-releases.html#iOS">iOS</a>
cristyda16f162011-02-19 23:52:17 +0000[diff] [blame]92</div>
93<div class="sub">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]94 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
95</div>
96<div class="sep"></div>
97<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]98 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]99</div>
100<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]101 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]102</div>
103<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]104 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]105</div>
106<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]107 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]108</div>
109<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]110 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111</div>
112<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]113 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]114</div>
115<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]116 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]117</div>
118<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]119 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
121<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]122 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]123</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]124<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]125<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]126 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]127</div>
128<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]129 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]130</div>
131<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]132 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]133 </div>
134<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]135 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]136</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]137<div class="menu">
138 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
139</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]140<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]141 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]142</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]143<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]144<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]145 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]146</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]147<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]148<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]149 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]150</div>
151<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]152 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]153</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]154<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]155<div class="menu">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]156 <a rel="follow" title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]157
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]158<a href="http://www.networkredux.com">
159 <img src="../../images/networkredux.png" alt="[sponsor]"
160 style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]161<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]162<div class="sponsor">
cristyba1758d2011-06-03 01:29:12 +0000[diff] [blame]163 <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
164</div>
165<div class="sponsor">
166 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
167</div>
168<div class="sponsor">
169 <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
170</div>
171<div class="sponsor">
cristy4bf6e232011-05-21 01:43:33 +0000[diff] [blame]172 <a rel="follow" title="Sponsor: Web Hosting Break" href="http://www.webhostingbreak.com">Web Hosting Break</a><!-- 201109010090 ian@ian-m... -->
cristy45dbd322011-03-27 16:40:38 +0000[diff] [blame]173</div>
174<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]175 <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
cristy4c54bbb2011-03-17 13:53:13 +0000[diff] [blame]176</div>
177<div class="sponsor">
cristy575d5ee2011-05-24 01:59:01 +0000[diff] [blame]178 <a rel="follow" title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201110010090 alexanian media -->
cristy4bf6e232011-05-21 01:43:33 +0000[diff] [blame]179</div>
180<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]181 <a rel="follow" title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]182</div>
183<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]184 <a rel="follow" title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
cristy7d52cd62010-10-01 17:26:59 +0000[diff] [blame]185</div>
186<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]187 <a rel="follow" title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
cristyee742642011-02-26 02:49:59 +0000[diff] [blame]188</div>
189<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]190 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingmasters.com">Web Hosting Reviews</a><!-- 201107011500 affliatelabel -->
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]191</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]192<div class="sponsor">
cristy10549a12011-05-15 19:04:46 +0000[diff] [blame]193 <a rel="follow" title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
cristybaacd172011-04-30 23:11:03 +0000[diff] [blame]194</div>
195<div class="sponsor">
cristye6e84152011-06-06 14:16:49 +0000[diff] [blame^]196 <a rel="follow" title="Sponsor: Fernsehdienst Berlin" href="http://www.atlas-multimedia.de">Fernsehdienst Berlin</a><!-- 2011090100025 atlas.multimedia-->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]197</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]198</div>
199</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]200</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]201
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]202<div class="eastbar">
cristyb52981c2011-03-19 17:09:31 +0000[diff] [blame]203
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]204</div>
205
206<div class="main">
207
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]208<h1>Module exception Methods</h1>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]209<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]210
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]211<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="AcquireExceptionInfo">AcquireExceptionInfo</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]212<div class="doc-section">
213
214<p>AcquireExceptionInfo() allocates the ExceptionInfo structure.</p>
215
216<p>The format of the AcquireExceptionInfo method is:</p>
217
218<pre class="code">
219 ExceptionInfo *AcquireExceptionInfo(void)
220</pre>
221
222 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]223<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="ClearMagickException">ClearMagickException</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]224<div class="doc-section">
225
226<p>ClearMagickException() clears any exception that may not have been caught yet.</p>
227
228<p>The format of the ClearMagickException method is:</p>
229
230<pre class="code">
231 ClearMagickException(ExceptionInfo *exception)
232</pre>
233
234<p>A description of each parameter follows:</p>
235
236<h5>exception</h5>
237<p>the exception info.</p>
238
239 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]240<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="CatchException">CatchException</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]241<div class="doc-section">
242
243<p>CatchException() returns if no exceptions is found otherwise it reports the exception as a warning, error, or fatal depending on the severity.</p>
244
245<p>The format of the CatchException method is:</p>
246
247<pre class="code">
248 CatchException(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>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]257<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="DestroyExceptionInfo">DestroyExceptionInfo</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]258<div class="doc-section">
259
260<p>DestroyExceptionInfo() deallocates memory associated with an exception.</p>
261
262<p>The format of the DestroyExceptionInfo method is:</p>
263
264<pre class="code">
265 ExceptionInfo *DestroyExceptionInfo(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>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]274<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="GetExceptionInfo">GetExceptionInfo</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]275<div class="doc-section">
276
277<p>GetExceptionInfo() initializes an exception to default values.</p>
278
279<p>The format of the GetExceptionInfo method is:</p>
280
281<pre class="code">
282 GetExceptionInfo(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>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]291<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="GetExceptionMessage">GetExceptionMessage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]292<div class="doc-section">
293
294<p>GetExceptionMessage() returns the error message defined by the specified error code.</p>
295
296<p>The format of the GetExceptionMessage method is:</p>
297
298<pre class="code">
299 char *GetExceptionMessage(const int error)
300</pre>
301
302<p>A description of each parameter follows:</p>
303
304<h5>error</h5>
305<p>the error code.</p>
306
307 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]308<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="GetLocaleExceptionMessage">GetLocaleExceptionMessage</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]309<div class="doc-section">
310
311<p>GetLocaleExceptionMessage() converts a enumerated exception severity and tag to a message in the current locale.</p>
312
313<p>The format of the GetLocaleExceptionMessage method is:</p>
314
315<pre class="code">
316 const char *GetLocaleExceptionMessage(const ExceptionType severity,
317 const char *tag)
318</pre>
319
320<p>A description of each parameter follows:</p>
321
322<h5>severity</h5>
323<p>the severity of the exception.</p>
324
325<h5>tag</h5>
326<p>the message tag.</p>
327
328 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]329<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="InheritException">InheritException</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]330<div class="doc-section">
331
332<p>InheritException() inherits an exception from a related exception.</p>
333
334<p>The format of the InheritException method is:</p>
335
336<pre class="code">
337 InheritException(ExceptionInfo *exception,const ExceptionInfo *relative)
338</pre>
339
340<p>A description of each parameter follows:</p>
341
342<h5>exception</h5>
343<p>the exception info.</p>
344
345<h5>relative</h5>
346<p>the related exception info.</p>
347
348 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]349<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="MagickError">MagickError</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]350<div class="doc-section">
351
352<p>MagickError() calls the exception handler methods with an error reason.</p>
353
354<p>The format of the MagickError method is:</p>
355
356<pre class="code">
357 void MagickError(const ExceptionType error,const char *reason,
358 const char *description)
359</pre>
360
361<p>A description of each parameter follows:</p>
362
363<h5>exception</h5>
364<p>Specifies the numeric error category.</p>
365
366<h5>reason</h5>
367<p>Specifies the reason to display before terminating the program.</p>
368
369<h5>description</h5>
370<p>Specifies any description to the reason.</p>
371
372 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]373<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="MagickFatalError">MagickFatalError</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]374<div class="doc-section">
375
376<p>MagickFatalError() calls the fatal exception handler methods with an error reason.</p>
377
378<p>The format of the MagickError method is:</p>
379
380<pre class="code">
381 void MagickFatalError(const ExceptionType error,const char *reason,
382 const char *description)
383</pre>
384
385<p>A description of each parameter follows:</p>
386
387<h5>exception</h5>
388<p>Specifies the numeric error category.</p>
389
390<h5>reason</h5>
391<p>Specifies the reason to display before terminating the program.</p>
392
393<h5>description</h5>
394<p>Specifies any description to the reason.</p>
395
396 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]397<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="MagickWarning">MagickWarning</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]398<div class="doc-section">
399
400<p>MagickWarning() calls the warning handler methods with a warning reason.</p>
401
402<p>The format of the MagickWarning method is:</p>
403
404<pre class="code">
405 void MagickWarning(const ExceptionType warning,const char *reason,
406 const char *description)
407</pre>
408
409<p>A description of each parameter follows:</p>
410
411<h5>warning</h5>
412<p>the warning severity.</p>
413
414<h5>reason</h5>
415<p>Define the reason for the warning.</p>
416
417<h5>description</h5>
418<p>Describe the warning.</p>
419
420 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]421<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="SetErrorHandler">SetErrorHandler</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]422<div class="doc-section">
423
424<p>SetErrorHandler() sets the exception handler to the specified method and returns the previous exception handler.</p>
425
426<p>The format of the SetErrorHandler method is:</p>
427
428<pre class="code">
429 ErrorHandler SetErrorHandler(ErrorHandler handler)
430</pre>
431
432<p>A description of each parameter follows:</p>
433
434<h5>handler</h5>
435<p>the method to handle errors.</p>
436
437 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]438<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="SetFatalErrorHandler">SetFatalErrorHandler</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]439<div class="doc-section">
440
441<p>SetFatalErrorHandler() sets the fatal exception handler to the specified method and returns the previous fatal 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>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]455<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="SetWarningHandler">SetWarningHandler</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]456<div class="doc-section">
457
458<p>SetWarningHandler() sets the warning handler to the specified method and returns the previous warning handler.</p>
459
460<p>The format of the SetWarningHandler method is:</p>
461
462<pre class="code">
463 ErrorHandler SetWarningHandler(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 warnings.</p>
470
471 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame]472<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="ThrowException">ThrowException</a></h2>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]473<div class="doc-section">
474
475<p>ThrowException() throws an exception with the specified severity code, reason, and optional description.</p>
476
477<p>The format of the ThrowException method is:</p>
478
479<pre class="code">
480 MagickBooleanType ThrowException(ExceptionInfo *exception,
481 const ExceptionType severity,const char *reason,
482 const char *description)
483</pre>
484
485<p>A description of each parameter follows:</p>
486
487<h5>exception</h5>
488<p>the exception info.</p>
489
490<h5>severity</h5>
491<p>the severity of the exception.</p>
492
493<h5>reason</h5>
494<p>the reason for the exception.</p>
495
496<h5>description</h5>
497<p>the exception description.</p>
498
499 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]500
501</div>
502
503<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]504 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]505 <span id="linkbar-center">
506 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]507 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]508 </span>
509 <span id="linkbar-east">&nbsp;</span>
510 </div>
511 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]512 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]513 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
514 </div>
515 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]516 <script type="text/javascript">
517 var _gaq = _gaq || [];
518 _gaq.push(['_setAccount', 'UA-17690367-1']);
519 _gaq.push(['_trackPageview']);
520
521 (function() {
522 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
523 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
524 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
525 })();
526 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]527</body>
528</html>