Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 72da67d4b155b1c525be87fcdc7a375b46550535 / . / www / api / exception.html
blob: 7494b7ef8b004c33cae40099173907168615e177 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html version="-//W3C//DTD XHTML 1.1//EN"
xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.w3.org/1999/xhtml
http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
<meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>
<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="application-name" content="ImageMagick"/>
<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."/>
<meta name="application-url" content="http://www.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, Image, Processing, Automagically"/>
<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-2012 ImageMagick Studio LLC"/>
<meta name="distribution" content="Global"/>
<link rel="icon" href="../../images/wand.png"/>
<link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
<link rel="canonical" href="http://www.imagemagick.org" />
<link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
<link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
<link rel="stylesheet" type="text/css" href="http://www.imagemagick.org/fancybox/jquery.fancybox-1.3.4.css" media="screen" />
<style type="text/css" media="all">
@import url("../../style/magick.php");
</style>
<script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script>
<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox-1.3.4.pack.js"></script>
<script type="text/javascript">
$(document).ready(function() {
$("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
'transitionIn' : 'elastic',
'transitionOut' : 'elastic',
'overlayShow' : false,
'opacity' : true
});
});
</script>
</head>
<body id="www-imagemagick-org">
<div class="titlebar">
<div style="margin: 17px auto; float: left;">
<script type="text/javascript">
<!--
google_ad_client = "pub-3129977114552745";
google_ad_slot = "5439289906";
google_ad_width = 728;
google_ad_height = 90;
//-->
</script>
<script type="text/javascript"
src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
</script>
</div>
<a href="../../discourse-server">
<img src="../../images/logo.jpg"
alt="ImageMagick Logo"
style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
<a href="http://www.imagemagick.org/ImageMagick-7.0.0/index.php">
<img src="../../images/sprite.jpg"
alt="ImageMagick Sprite"
style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
</div>
<div class="westbar">
<div class="menu">
<a title="About ImageMagick" href="http://www.imagemagick.org/ImageMagick-7.0.0/index.php">About ImageMagick</a>
</div>
<div class="menu">
<a title="Binary Releases" href="../../script/binary-releases.php">Binary Releases</a>
</div>
<div class="sub">
<a title="Binary Release: Unix" href="../../script/binary-releases.php#unix">Unix</a>
</div>
<div class="sub">
<a title="Binary Release: MacOS X" href="../../script/binary-releases.php#macosx">Mac OS X</a>
</div>
<div class="sub">
<a title="Binary Release: iOS" href="../../script/binary-releases.php#iOS">iOS</a>
</div>
<div class="sub">
<a title="Binary Release: Windows" href="../../script/binary-releases.php#windows">Windows</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Command-line Tools" href="../../script/command-line-tools.php">Command-line Tools</a>
</div>
<div class="sub">
<a title="Command-line Tools: Processing" href="../../script/command-line-processing.php">Processing</a>
</div>
<div class="sub">
<a title="Command-line Tools: Options" href="../../script/command-line-options.php">Options</a>
</div>
<div class="sub">
<a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
</div>
<div class="menu">
<a title="Program Interfaces" href="../../script/api.php">Program Interfaces</a>
</div>
<div class="sub">
<a title="Program Interface: MagickWand" href="../../script/magick-wand.php">MagickWand</a>
</div>
<div class="sub">
<a title="Program Interface: MagickCore" href="../../script/magick-core.php">MagickCore</a>
</div>
<div class="sub">
<a title="Program Interface: PerlMagick" href="../../script/perl-magick.php">PerlMagick</a>
</div>
<div class="sub">
<a title="Program Interface: Magick++" href="../../script/magick++.php">Magick++</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Install from Source" href="../../script/install-source.php">Install from Source</a>
</div>
<div class="sub">
<a title="Install from Source: Unix" href="../../script/install-source.php#unix">Unix</a>
</div>
<div class="sub">
<a title="Install from Source: Windows" href="../../script/install-source.php#windows">Windows</a>
</div>
<div class="menu">
<a title="Resources" href="../../script/resources.php">Resources</a>
</div>
<div class="menu">
<a title="Architecture" href="../../script/architecture.php">Architecture</a>
</div>
<div class="menu">
<a title="Download" href="../../script/download.php">Download</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Search" href="../../script/search.php">Search</a>
</div>
<div class="sep"></div>
<div class="menu">
<a title="Site Map" href="../../script/sitemap.php">Site Map</a>
</div>
<div class="sub">
<a title="Site Map: Links" href="../../script/links.php">Links</a>
</div>
<div class="sep"></div>
<div class="menu">
<a rel="follow" title="Sponsors" href="../../script/sponsors.php">Sponsors:</a>
<a href="http://www.networkredux.com">
<img src="../../images/networkredux.png" width="140" height="31" alt="[sponsor]"
style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
<div class="sponsbox">
<div class="sponsor">
<a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 2012070100250 ... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Stock Photography" href="http://www.fotosearch.com/">Stock Photography</a><!-- 2012040100250 ... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Best Local Services" href="http://www.openchime.com">Best Local Services</a><!-- 2012010100150 joey@openc... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Managed Server" href="http://www.robhost.de">Managed Server</a><!-- 201210010720 klikics... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: VPS" href="http://www.interdominios.com/vps">VPS</a><!-- 201201010090 barsh@inter... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Autoteile" href="http://www.q11-shop.de">Autoteile</a><!-- 201205010540 suvalj -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Web Hosting" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Autos part" href="http://www.pkwteile.de/autoteile">Autos part</a><!-- 201112010090s jr@pkwte... -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Günstige Turbolader" href="http://www.autoteile-carparts.de/">Günstige Turbolader</a><!-- 20111101000030 -->
</div>
<div class="sponsor">
<a rel="follow" title="Sponsor: Got Stripes?" href="http://www.stripeslawncare.org">Got Stripes?</a><!-- 2012010100150 brooks@stripes...-->
</div>
</div>
</div>
</div>
<div class="eastbar">
<div class="g-plusone" id="gplusone"></div>
<script type="text/javascript">
window.___gcfg = {
lang: 'en-US'
};
(function() {
var po = document.createElement('offline-script');
po.type = 'text/javascript'; po.async = true;
po.src = 'https://apis.google.com/js/plusone.js';
var script = document.getElementsByTagName('offline-script')[0];
script.parentNode.insertBefore(po, script);
})();
var gplusone = document.getElementById("gplusone");
gplusone.setAttribute("data-size","medium");
gplusone.setAttribute("data-count","false");
</script>
</div>
<div class="main">
<h1>Module exception Methods</h1>
<p class="navigation-index">[<a href="exception.php#AcquireExceptionInfo">AcquireExceptionInfo</a> &bull; <a href="exception.php#ClearMagickException">ClearMagickException</a> &bull; <a href="exception.php#CatchException">CatchException</a> &bull; <a href="exception.php#DestroyExceptionInfo">DestroyExceptionInfo</a> &bull; <a href="exception.php#GetExceptionInfo">GetExceptionInfo</a> &bull; <a href="exception.php#GetExceptionMessage">GetExceptionMessage</a> &bull; <a href="exception.php#GetLocaleExceptionMessage">GetLocaleExceptionMessage</a> &bull; <a href="exception.php#InheritException">InheritException</a> &bull; <a href="exception.php#MagickError">MagickError</a> &bull; <a href="exception.php#MagickFatalError">MagickFatalError</a> &bull; <a href="exception.php#MagickWarning">MagickWarning</a> &bull; <a href="exception.php#SetErrorHandler">SetErrorHandler</a> &bull; <a href="exception.php#SetFatalErrorHandler">SetFatalErrorHandler</a> &bull; <a href="exception.php#SetWarningHandler">SetWarningHandler</a> &bull; <a href="exception.php#ThrowException">ThrowException</a>]</p>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="AcquireExceptionInfo">AcquireExceptionInfo</a></h2>
<div class="doc-section">
<p>AcquireExceptionInfo() allocates the ExceptionInfo structure.</p>
<p>The format of the AcquireExceptionInfo method is:</p>
<pre class="code">
ExceptionInfo *AcquireExceptionInfo(void)
</pre>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="ClearMagickException">ClearMagickException</a></h2>
<div class="doc-section">
<p>ClearMagickException() clears any exception that may not have been caught yet.</p>
<p>The format of the ClearMagickException method is:</p>
<pre class="code">
ClearMagickException(ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p>
<h5>exception</h5>
<p>the exception info.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="CatchException">CatchException</a></h2>
<div class="doc-section">
<p>CatchException() returns if no exceptions is found otherwise it reports the exception as a warning, error, or fatal depending on the severity.</p>
<p>The format of the CatchException method is:</p>
<pre class="code">
CatchException(ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p>
<h5>exception</h5>
<p>the exception info.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="DestroyExceptionInfo">DestroyExceptionInfo</a></h2>
<div class="doc-section">
<p>DestroyExceptionInfo() deallocates memory associated with an exception.</p>
<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>
<h5>exception</h5>
<p>the exception info.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="GetExceptionInfo">GetExceptionInfo</a></h2>
<div class="doc-section">
<p>GetExceptionInfo() initializes an exception to default values.</p>
<p>The format of the GetExceptionInfo method is:</p>
<pre class="code">
GetExceptionInfo(ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p>
<h5>exception</h5>
<p>the exception info.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="GetExceptionMessage">GetExceptionMessage</a></h2>
<div class="doc-section">
<p>GetExceptionMessage() returns the error message defined by the specified error code.</p>
<p>The format of the GetExceptionMessage method is:</p>
<pre class="code">
char *GetExceptionMessage(const int error)
</pre>
<p>A description of each parameter follows:</p>
<h5>error</h5>
<p>the error code.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="GetLocaleExceptionMessage">GetLocaleExceptionMessage</a></h2>
<div class="doc-section">
<p>GetLocaleExceptionMessage() converts a enumerated exception severity and tag to a message in the current locale.</p>
<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>
<h5>severity</h5>
<p>the severity of the exception.</p>
<h5>tag</h5>
<p>the message tag.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="InheritException">InheritException</a></h2>
<div class="doc-section">
<p>InheritException() inherits an exception from a related exception.</p>
<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>
<h5>exception</h5>
<p>the exception info.</p>
<h5>relative</h5>
<p>the related exception info.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="MagickError">MagickError</a></h2>
<div class="doc-section">
<p>MagickError() calls the exception handler methods with an error reason.</p>
<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>
<h5>exception</h5>
<p>Specifies the numeric error category.</p>
<h5>reason</h5>
<p>Specifies the reason to display before terminating the program.</p>
<h5>description</h5>
<p>Specifies any description to the reason.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="MagickFatalError">MagickFatalError</a></h2>
<div class="doc-section">
<p>MagickFatalError() calls the fatal exception handler methods with an error reason.</p>
<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>
<h5>exception</h5>
<p>Specifies the numeric error category.</p>
<h5>reason</h5>
<p>Specifies the reason to display before terminating the program.</p>
<h5>description</h5>
<p>Specifies any description to the reason.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="MagickWarning">MagickWarning</a></h2>
<div class="doc-section">
<p>MagickWarning() calls the warning handler methods with a warning reason.</p>
<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>
<h5>warning</h5>
<p>the warning severity.</p>
<h5>reason</h5>
<p>Define the reason for the warning.</p>
<h5>description</h5>
<p>Describe the warning.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="SetErrorHandler">SetErrorHandler</a></h2>
<div class="doc-section">
<p>SetErrorHandler() sets the exception handler to the specified method and returns the previous exception handler.</p>
<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>
<h5>handler</h5>
<p>the method to handle errors.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="SetFatalErrorHandler">SetFatalErrorHandler</a></h2>
<div class="doc-section">
<p>SetFatalErrorHandler() sets the fatal exception handler to the specified method and returns the previous fatal exception handler.</p>
<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>
<h5>handler</h5>
<p>the method to handle errors.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="SetWarningHandler">SetWarningHandler</a></h2>
<div class="doc-section">
<p>SetWarningHandler() sets the warning handler to the specified method and returns the previous warning handler.</p>
<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>
<h5>handler</h5>
<p>the method to handle warnings.</p>
</div>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="ThrowException">ThrowException</a></h2>
<div class="doc-section">
<p>ThrowException() throws an exception with the specified severity code, reason, and optional description.</p>
<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>
<h5>exception</h5>
<p>the exception info.</p>
<h5>severity</h5>
<p>the severity of the exception.</p>
<h5>reason</h5>
<p>the reason for the exception.</p>
<h5>description</h5>
<p>the exception description.</p>
</div>
</div>
<div id="linkbar">
<span id="linkbar-west">&nbsp;</span>
<span id="linkbar-center">
<a href="../../discourse-server">Discourse Server</a> &bull;
<a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
</span>
<span id="linkbar-east">&nbsp;</span>
</div>
<div class="footer">
<span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
<span id="footer-east"> <a href="../../script/contact.php">Contact the Wizards</a></span>
</div>
<div style="clear: both; margin: 0; width: 100%; "></div>
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-17690367-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('offline-script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('offline-script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
</body>
</html>