Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 350dea44cca73cc46ce2183e1851c5b254c7921e / . / www / api / exception.html
blob: 0a21518067cf4e5185db86ce90dd9c06c97ba648 [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"/>
cristyaf8d6652011-02-04 21:57:45 +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."/>
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"/>
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, Swiss, Army, Knife, Image, Processing"/>
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">
52<a href="../../index.html">
53 <img src="../../images/script.png" alt="[ImageMagick]"
54 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
55<a href="http://www.networkredux.com">
56 <img src="../../images/networkredux.png" alt="[sponsor]"
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]57 style="margin-top: 42px; border: 0px; float: left;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]58<a href="http://www.imagemagick.org/discourse-server/">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]59 <img src="../../images/logo.jpg"
60 alt="ImageMagick Logo"
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]61 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]62<a href="../../index.html">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]63 <img src="../../images/sprite.jpg"
64 alt="ImageMagick Sprite"
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]65 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
66</div>
67
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]68<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]69
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]70<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]71 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]72</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]73<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]74<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]75 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
76</div>
77<div class="sub">
78 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
79</div>
80<div class="sub">
81 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
82</div>
83<div class="sub">
84 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
85</div>
86<div class="sep"></div>
87<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]88 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]89</div>
90<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]91 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]92</div>
93<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]94 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]95</div>
96<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]97 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]98</div>
99<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]100 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]101</div>
102<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]103 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]104</div>
105<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]106 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107</div>
108<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]109 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]110</div>
111<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]112 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]115<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]116 <a title="Install from Source" href="../../www/install-source.html">Install from Source</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="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
121<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]122 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]123 </div>
124<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]125 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]126</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]127<div class="menu">
128 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
129</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]130<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]131 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]132</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]133<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]134<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]135 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]136</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]137<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]138<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]139 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]140</div>
141<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]142 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]143</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]144<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]145<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]146 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]147
148<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]149<div class="sponsor">
cristyaf8d6652011-02-04 21:57:45 +0000[diff] [blame]150 <a title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
151</div>
152<div class="sponsor">
153 <a title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
154</div>
155<div class="sponsor">
cristy2bd2a982011-02-15 00:52:58 +0000[diff] [blame]156 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201107010240 r.leo -->
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]157</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]158<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]159 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
cristy7d52cd62010-10-01 17:26:59 +0000[diff] [blame]160</div>
161<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]162 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
163</div>
164<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]165 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
166</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]167<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]168 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
169</div>
170<div class="sponsor">
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]171 <a title="Sponsor: alaTest.com" href="http://alatest.com">alaTest.com</a><!-- 20110801000300 -->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]172</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]173</div>
174</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]175</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]176
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]177<div class="eastbar">
178 <script type="text/javascript">
179 <!--
180 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]181 google_ad_slot = "0574824969";
182 google_ad_width = 160;
183 google_ad_height = 600;
184 //-->
185 </script>
186 <script type="text/javascript"
187 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
188 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]189</div>
190
191<div class="main">
192
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]193<h1>Module exception Methods</h1>
cristy6f77f692011-02-15 15:31:39 +0000[diff] [blame]194<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]195
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]196<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]197<div class="doc-section">
198
199<p>AcquireExceptionInfo() allocates the ExceptionInfo structure.</p>
200
201<p>The format of the AcquireExceptionInfo method is:</p>
202
203<pre class="code">
204 ExceptionInfo *AcquireExceptionInfo(void)
205</pre>
206
207 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]208<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]209<div class="doc-section">
210
211<p>ClearMagickException() clears any exception that may not have been caught yet.</p>
212
213<p>The format of the ClearMagickException method is:</p>
214
215<pre class="code">
216 ClearMagickException(ExceptionInfo *exception)
217</pre>
218
219<p>A description of each parameter follows:</p>
220
221<h5>exception</h5>
222<p>the exception info.</p>
223
224 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]225<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]226<div class="doc-section">
227
228<p>CatchException() returns if no exceptions is found otherwise it reports the exception as a warning, error, or fatal depending on the severity.</p>
229
230<p>The format of the CatchException method is:</p>
231
232<pre class="code">
233 CatchException(ExceptionInfo *exception)
234</pre>
235
236<p>A description of each parameter follows:</p>
237
238<h5>exception</h5>
239<p>the exception info.</p>
240
241 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]242<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]243<div class="doc-section">
244
245<p>DestroyExceptionInfo() deallocates memory associated with an exception.</p>
246
247<p>The format of the DestroyExceptionInfo method is:</p>
248
249<pre class="code">
250 ExceptionInfo *DestroyExceptionInfo(ExceptionInfo *exception)
251</pre>
252
253<p>A description of each parameter follows:</p>
254
255<h5>exception</h5>
256<p>the exception info.</p>
257
258 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]259<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]260<div class="doc-section">
261
262<p>GetExceptionInfo() initializes an exception to default values.</p>
263
264<p>The format of the GetExceptionInfo method is:</p>
265
266<pre class="code">
267 GetExceptionInfo(ExceptionInfo *exception)
268</pre>
269
270<p>A description of each parameter follows:</p>
271
272<h5>exception</h5>
273<p>the exception info.</p>
274
275 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]276<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]277<div class="doc-section">
278
279<p>GetExceptionMessage() returns the error message defined by the specified error code.</p>
280
281<p>The format of the GetExceptionMessage method is:</p>
282
283<pre class="code">
284 char *GetExceptionMessage(const int error)
285</pre>
286
287<p>A description of each parameter follows:</p>
288
289<h5>error</h5>
290<p>the error code.</p>
291
292 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]293<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]294<div class="doc-section">
295
296<p>GetLocaleExceptionMessage() converts a enumerated exception severity and tag to a message in the current locale.</p>
297
298<p>The format of the GetLocaleExceptionMessage method is:</p>
299
300<pre class="code">
301 const char *GetLocaleExceptionMessage(const ExceptionType severity,
302 const char *tag)
303</pre>
304
305<p>A description of each parameter follows:</p>
306
307<h5>severity</h5>
308<p>the severity of the exception.</p>
309
310<h5>tag</h5>
311<p>the message tag.</p>
312
313 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]314<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]315<div class="doc-section">
316
317<p>InheritException() inherits an exception from a related exception.</p>
318
319<p>The format of the InheritException method is:</p>
320
321<pre class="code">
322 InheritException(ExceptionInfo *exception,const ExceptionInfo *relative)
323</pre>
324
325<p>A description of each parameter follows:</p>
326
327<h5>exception</h5>
328<p>the exception info.</p>
329
330<h5>relative</h5>
331<p>the related exception info.</p>
332
333 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]334<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]335<div class="doc-section">
336
337<p>MagickError() calls the exception handler methods with an error reason.</p>
338
339<p>The format of the MagickError method is:</p>
340
341<pre class="code">
342 void MagickError(const ExceptionType error,const char *reason,
343 const char *description)
344</pre>
345
346<p>A description of each parameter follows:</p>
347
348<h5>exception</h5>
349<p>Specifies the numeric error category.</p>
350
351<h5>reason</h5>
352<p>Specifies the reason to display before terminating the program.</p>
353
354<h5>description</h5>
355<p>Specifies any description to the reason.</p>
356
357 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]358<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]359<div class="doc-section">
360
361<p>MagickFatalError() calls the fatal exception handler methods with an error reason.</p>
362
363<p>The format of the MagickError method is:</p>
364
365<pre class="code">
366 void MagickFatalError(const ExceptionType error,const char *reason,
367 const char *description)
368</pre>
369
370<p>A description of each parameter follows:</p>
371
372<h5>exception</h5>
373<p>Specifies the numeric error category.</p>
374
375<h5>reason</h5>
376<p>Specifies the reason to display before terminating the program.</p>
377
378<h5>description</h5>
379<p>Specifies any description to the reason.</p>
380
381 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]382<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]383<div class="doc-section">
384
385<p>MagickWarning() calls the warning handler methods with a warning reason.</p>
386
387<p>The format of the MagickWarning method is:</p>
388
389<pre class="code">
390 void MagickWarning(const ExceptionType warning,const char *reason,
391 const char *description)
392</pre>
393
394<p>A description of each parameter follows:</p>
395
396<h5>warning</h5>
397<p>the warning severity.</p>
398
399<h5>reason</h5>
400<p>Define the reason for the warning.</p>
401
402<h5>description</h5>
403<p>Describe the warning.</p>
404
405 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]406<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]407<div class="doc-section">
408
409<p>SetErrorHandler() sets the exception handler to the specified method and returns the previous exception handler.</p>
410
411<p>The format of the SetErrorHandler method is:</p>
412
413<pre class="code">
414 ErrorHandler SetErrorHandler(ErrorHandler handler)
415</pre>
416
417<p>A description of each parameter follows:</p>
418
419<h5>handler</h5>
420<p>the method to handle errors.</p>
421
422 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]423<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]424<div class="doc-section">
425
426<p>SetFatalErrorHandler() sets the fatal exception handler to the specified method and returns the previous fatal exception handler.</p>
427
428<p>The format of the SetErrorHandler method is:</p>
429
430<pre class="code">
431 ErrorHandler SetErrorHandler(ErrorHandler handler)
432</pre>
433
434<p>A description of each parameter follows:</p>
435
436<h5>handler</h5>
437<p>the method to handle errors.</p>
438
439 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]440<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]441<div class="doc-section">
442
443<p>SetWarningHandler() sets the warning handler to the specified method and returns the previous warning handler.</p>
444
445<p>The format of the SetWarningHandler method is:</p>
446
447<pre class="code">
448 ErrorHandler SetWarningHandler(ErrorHandler handler)
449</pre>
450
451<p>A description of each parameter follows:</p>
452
453<h5>handler</h5>
454<p>the method to handle warnings.</p>
455
456 </div>
cristy350dea42011-02-15 17:31:04 +0000[diff] [blame^]457<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]458<div class="doc-section">
459
460<p>ThrowException() throws an exception with the specified severity code, reason, and optional description.</p>
461
462<p>The format of the ThrowException method is:</p>
463
464<pre class="code">
465 MagickBooleanType ThrowException(ExceptionInfo *exception,
466 const ExceptionType severity,const char *reason,
467 const char *description)
468</pre>
469
470<p>A description of each parameter follows:</p>
471
472<h5>exception</h5>
473<p>the exception info.</p>
474
475<h5>severity</h5>
476<p>the severity of the exception.</p>
477
478<h5>reason</h5>
479<p>the reason for the exception.</p>
480
481<h5>description</h5>
482<p>the exception description.</p>
483
484 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]485
486</div>
487
488<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]489 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]490 <span id="linkbar-center">
491 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]492 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]493 </span>
494 <span id="linkbar-east">&nbsp;</span>
495 </div>
496 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]497 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]498 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
499 </div>
500 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]501 <script type="text/javascript">
502 var _gaq = _gaq || [];
503 _gaq.push(['_setAccount', 'UA-17690367-1']);
504 _gaq.push(['_trackPageview']);
505
506 (function() {
507 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
508 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
509 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
510 })();
511 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]512</body>
513</html>