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