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