File: //usr/share/doc/ImageMagick-6.4.8/www/api/exception.html
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
<head>
<style type="text/css" media="screen,projection"><!--
@import url("../../www/magick.css");
//--></style>
<meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
<link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
<title>ImageMagick: MagickCore, C API for ImageMagick: Dealing with Exceptions</title>
<meta http-equiv="Content-Language" content="en-US"/>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
<meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
<meta name="Generator" content="PHP"/>
<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"/>
<meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves. ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems. The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
<meta name="Rating" content="GENERAL"/>
<meta name="Robots" content="INDEX, FOLLOW"/>
<meta name="Generator" content="ImageMagick Studio LLC"/>
<meta name="Author" content="ImageMagick Studio LLC"/>
<meta name="Revisit-after" content="2 DAYS"/>
<meta name="Resource-type" content="document"/>
<meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
<meta name="Distribution" content="Global"/>
<link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
</head>
<body id="www-imagemagick-org">
<table id="titlebar" style="width: 100%;background-color: #f5f5f5" cellpadding="0" cellspacing="0" border="0" summary="ImageMagick">
<tbody>
<tr valign="top">
<td align="left"><a href="../../index.html"><img id="titlebar-west" src="../../images/script.png" alt="[ImageMagick]" width="350" height="60" vspace="28" name="titlebar-west"/></a></td>
<td align="left"><a href="http://www.networkredux.com" target="525193859"><img id="titlebar-west" src="../../images/networkredux.png" alt="[sponsor]" border="0" vspace="45" name="titlebar-west"/></a></td>
<td width="99%"><br /> </td>
<td style="background-color: white" align="right"><a href="../../index.html"><img src="../../images/sprite.jpg" alt="" width="114" height="118" border="0" name="titlebar-east"/></a></td>
<td style="background-color: white" align="right"><a href="http://www.imagemagick.org/discourse-server/" target="1260795187"><img id="titlebar-east" src="../../images/logo.jpg" alt="" width="114" height="118" border="0" name="titlebar-east"/></a></td>
</tr>
</tbody>
</table>
<table style="width: 100%" border="0" cellpadding="0" cellspacing="0" summary="">
<tbody>
<tr valign="top" style="height: 100%;">
<td id="menu" width="1%" height="100%">
<p><a href="#main">Skip to page contents</a></p>
<font size="-1">
<span>[</span>
<a href="../../index.html">About ImageMagick</a>
<span>]</span><br /><span>[</span>
<a href="../../www/command-line-tools.html">Command-line Tools</a>
<a href="../../www/command-line-processing.html" class="sub">Processing</a>
<a href="../../www/command-line-options.html" class="sub">Options</a>
<a href="http://www.imagemagick.org/Usage/" target="805170881" class="sub">Usage</a>
<a href="../../www/api.html">Program Interfaces</a>
<a href="../../www/magick-wand.html" class="sub">MagickWand</a>
<a href="../../www/magick-core.html" class="sub">MagickCore</a>
<a href="../../www/perl-magick.html" class="sub">PerlMagick</a>
<a href="../../Magick++/" target="993927764" class="sub">Magick++</a>
<a href="../../www/architecture.html">Architecture</a>
<span>]</span><br /><span>[</span>
<a href="../../www/install-source.html">Install from Source</a>
<a href="../../www/install-source.html#unix" class="sub">Unix</a>
<a href="../../www/install-source.html#windows" class="sub">Windows</a>
<a href="../../www/binary-releases.html">Binary Releases</a>
<a href="../../www/binary-releases.html#unix" class="sub">Unix</a>
<a href="../../www/binary-releases.html#macosx" class="sub">Mac OS X</a>
<a href="../../www/binary-releases.html#windows" class="sub">Windows</a>
<a href="../../www/resources.html">Resources</a>
<span>]</span><br /><span>[</span>
<a href="../../www/download.html">Download</a>
<span>]</span><br /><span>[</span>
<a href="../../www/sitemap.html">Site Map</a>
<a href="../../www/links.html" class="sub">Links</a>
<span>]</span><br /><span>[</span>
<a href="../../www/sponsors.html">Sponsors:</a>
<fieldset>
<a href="http://www.17things.com/" class="sponsor" target="sponsor">Answers to Questions</a><!-- 200904010200 -->
<br />
<a href="http://meta-preisvergleich.de" class="sponsor" target="sponsor">Preisvergleich</a><!-- 200902010120 -->
<br />
<a href="http://www.checkcost.co.uk" class="sponsor" target="sponsor">Compare</a><!-- 200902010720 -->
<br />
<a href="http://www.ecostsoftware.com" class="sponsor" target="sponsor">Software</a><!-- 200902010720 -->
<br />
<a href="http://www.callerbase.com" class="sponsor" target="sponsor">Phone Number<br />Search</a><!-- 200902010040 -->
<br />
<a href="http://www.online-kredit-index.de" class="sponsor" target="sponsor">Kredit</a><!-- 200904010120 -->
<br />
<a href="http://www.posters555.com" class="sponsor" target="sponsor">Poster</a><!-- 200903010800 -->
</fieldset>
<span>]</span>
</font>
</td>
<td id="main" valign="top">
<p class="navigation-index">[ <a href="#AcquireExceptionInfo">AcquireExceptionInfo</a> | <a href="#ClearMagickException">ClearMagickException</a> | <a href="#CatchException">CatchException</a> | <a href="#DestroyExceptionInfo">DestroyExceptionInfo</a> | <a href="#GetExceptionInfo">GetExceptionInfo</a> | <a href="#GetExceptionMessage">GetExceptionMessage</a> | <a href="#GetLocaleExceptionMessage">GetLocaleExceptionMessage</a> | <a href="#InheritException">InheritException</a> | <a href="#MagickError">MagickError</a> | <a href="#MagickFatalError">MagickFatalError</a> | <a href="#MagickWarning">MagickWarning</a> | <a href="#SetErrorHandler">SetErrorHandler</a> | <a href="#SetFatalErrorHandler">SetFatalErrorHandler</a> | <a href="#SetWarningHandler">SetWarningHandler</a> | <a href="#ThrowException">ThrowException</a> ]</p>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception
_8c.html" target="source" name="AcquireExceptionInfo">AcquireExceptionInfo</a></h2>
</div>
<p>AcquireExceptionInfo() allocates the ExceptionInfo structure.</p></ol>
<p>The format of the AcquireExceptionInfo method is:</p>
<pre class="code">
ExceptionInfo *AcquireExceptionInfo(void)
</pre>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception
_8c.html" target="source" name="ClearMagickException">ClearMagickException</a></h2>
</div>
<p>ClearMagickException() clears any exception that may not have been caught yet.</p></ol>
<p>The format of the ClearMagickException method is:</p>
<pre class="code">
ClearMagickException(ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>exception</h5>
<ol><p>the exception info.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception
_8c.html" target="source" name="CatchException">CatchException</a></h2>
</div>
<p>CatchException() returns if no exceptions is found otherwise it reports the exception as a warning, error, or fatal depending on the severity.</p></ol>
<p>The format of the CatchException method is:</p>
<pre class="code">
CatchException(ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>exception</h5>
<ol><p>the exception info.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception
_8c.html" target="source" name="DestroyExceptionInfo">DestroyExceptionInfo</a></h2>
</div>
<p>DestroyExceptionInfo() deallocates memory associated with an exception.</p></ol>
<p>The format of the DestroyExceptionInfo method is:</p>
<pre class="code">
ExceptionInfo *DestroyExceptionInfo(ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>exception</h5>
<ol><p>the exception info.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception
_8c.html" target="source" name="GetExceptionInfo">GetExceptionInfo</a></h2>
</div>
<p>GetExceptionInfo() initializes an exception to default values.</p></ol>
<p>The format of the GetExceptionInfo method is:</p>
<pre class="code">
GetExceptionInfo(ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>exception</h5>
<ol><p>the exception info.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception
_8c.html" target="source" name="GetExceptionMessage">GetExceptionMessage</a></h2>
</div>
<p>GetExceptionMessage() returns the error message defined by the specified error code.</p></ol>
<p>The format of the GetExceptionMessage method is:</p>
<pre class="code">
char *GetExceptionMessage(const int error_code)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>error_code</h5>
<ol><p>the error code.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception
_8c.html" target="source" name="GetLocaleExceptionMessage">GetLocaleExceptionMessage</a></h2>
</div>
<p>GetLocaleExceptionMessage() converts a enumerated exception severity and tag to a message in the current locale.</p></ol>
<p>The format of the GetLocaleExceptionMessage method is:</p>
<pre class="code">
const char *GetLocaleExceptionMessage(const ExceptionType severity,
const char *tag)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>severity</h5>
<ol><p>the severity of the exception.</p></ol>
<h5>tag</h5>
<ol><p>the message tag.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception
_8c.html" target="source" name="InheritException">InheritException</a></h2>
</div>
<p>InheritException() inherits an exception from a related exception.</p></ol>
<p>The format of the InheritException method is:</p>
<pre class="code">
InheritException(ExceptionInfo *exception,const ExceptionInfo *relative)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>exception</h5>
<ol><p>the exception info.</p></ol>
<h5>relative</h5>
<ol><p>the related exception info.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception
_8c.html" target="source" name="MagickError">MagickError</a></h2>
</div>
<p>MagickError() calls the exception handler methods with an error reason.</p></ol>
<p>The format of the MagickError method is:</p>
<pre class="code">
void MagickError(const ExceptionType error,const char *reason,
const char *description)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>exception</h5>
<ol><p>Specifies the numeric error category.</p></ol>
<h5>reason</h5>
<ol><p>Specifies the reason to display before terminating the program.</p></ol>
<h5>description</h5>
<ol><p>Specifies any description to the reason.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception
_8c.html" target="source" name="MagickFatalError">MagickFatalError</a></h2>
</div>
<p>MagickFatalError() calls the fatal exception handler methods with an error reason.</p></ol>
<p>The format of the MagickError method is:</p>
<pre class="code">
void MagickFatalError(const ExceptionType error,const char *reason,
const char *description)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>exception</h5>
<ol><p>Specifies the numeric error category.</p></ol>
<h5>reason</h5>
<ol><p>Specifies the reason to display before terminating the program.</p></ol>
<h5>description</h5>
<ol><p>Specifies any description to the reason.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception
_8c.html" target="source" name="MagickWarning">MagickWarning</a></h2>
</div>
<p>MagickWarning() calls the warning handler methods with a warning reason.</p></ol>
<p>The format of the MagickWarning method is:</p>
<pre class="code">
void MagickWarning(const ExceptionType warning,const char *reason,
const char *description)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>warning</h5>
<ol><p>the warning severity.</p></ol>
<h5>reason</h5>
<ol><p>Define the reason for the warning.</p></ol>
<h5>description</h5>
<ol><p>Describe the warning.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception
_8c.html" target="source" name="SetErrorHandler">SetErrorHandler</a></h2>
</div>
<p>SetErrorHandler() sets the exception handler to the specified method and returns the previous exception handler.</p></ol>
<p>The format of the SetErrorHandler method is:</p>
<pre class="code">
ErrorHandler SetErrorHandler(ErrorHandler handler)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>handler</h5>
<ol><p>the method to handle errors.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception
_8c.html" target="source" name="SetFatalErrorHandler">SetFatalErrorHandler</a></h2>
</div>
<p>SetFatalErrorHandler() sets the fatal exception handler to the specified method and returns the previous fatal exception handler.</p></ol>
<p>The format of the SetErrorHandler method is:</p>
<pre class="code">
ErrorHandler SetErrorHandler(ErrorHandler handler)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>handler</h5>
<ol><p>the method to handle errors.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception
_8c.html" target="source" name="SetWarningHandler">SetWarningHandler</a></h2>
</div>
<p>SetWarningHandler() sets the warning handler to the specified method and returns the previous warning handler.</p></ol>
<p>The format of the SetWarningHandler method is:</p>
<pre class="code">
ErrorHandler SetWarningHandler(ErrorHandler handler)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>handler</h5>
<ol><p>the method to handle warnings.</p></ol>
<div style="margin: auto;">
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception
_8c.html" target="source" name="ThrowException">ThrowException</a></h2>
</div>
<p>ThrowException() throws an exception with the specified severity code, reason, and optional description.</p></ol>
<p>The format of the ThrowException method is:</p>
<pre class="code">
MagickBooleanType ThrowException(ExceptionInfo *exception,
const ExceptionType severity,const char *reason,
const char *description)
</pre>
<p>A description of each parameter follows:</p></ol>
<h5>exception</h5>
<ol><p>the exception info.</p></ol>
<h5>severity</h5>
<ol><p>the severity of the exception.</p></ol>
<h5>tag</h5>
<ol><p>the message tag.</p></ol>
<h5>description</h5>
<ol><p>the exception description.</p></ol>
</td>
<td id="margin" width="1%" height="100%" valign="top" align="right"> </td>
</tr>
</tbody>
</table>
<div id="linkbar">
<span id="linkbar-west">
<font size="-1">
</font>
</span>
<span id="linkbar-center">
<a href="http://www.imagemagick.org/discourse-server/" target="457508850">Discourse Server</a> •
<a href="../../www/mailing-list.html">Mailing Lists</a> •
<a href="http://cafe.imagemagick.org" target="558102977">Cafe</a> •
<a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi" target="329285287">Studio</a>
</span>
<span id="linkbar-east">
<font size="-1">
</font>
</span>
</div>
<div id="footer">
<span id="footer-west">© 1999-2009 ImageMagick Studio LLC</span>
</div>
<div style="clear: both; margin: 0; width: 100%; "></div>
</body>
</html>