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