blob: 5c0a20bbdd34f2bc5f8297715aeeb058dbbefc0f [file] [log] [blame]
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<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="ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.">
<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, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert">
<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-2015 ImageMagick Studio LLC">
<meta name="distribution" content="Global">
<meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1">
<link rel="icon" href="../images/wand.png">
<link rel="shortcut icon" href="../images/wand.ico" type="images/x-icon">
<link rel="stylesheet" href="../css/bootstrap.min.css">
<link rel="stylesheet" href="../css/magick.css">
</head>
<body>
<div class="main">
<div class="magick-masthead">
<div class="container">
<script type="text/javascript">
<!--
google_ad_client = "pub-3129977114552745";
google_ad_slot = "5439289906";
google_ad_width = 728;
google_ad_height = 90;
//-->
</script>
<center><script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
</script></center>
<nav class="magick-nav">
<a class="magick-nav-item " href="../index.html">Home</a>
<a class="magick-nav-item " href="../binary-releases.html">Downloads</a>
<a class="magick-nav-item " href="../command-line-tools.html">Tools</a>
<a class="magick-nav-item " href="../command-line-options.html">Options</a>
<a class="magick-nav-item " href="api.html">Development</a>
<a class="magick-nav-item" href="http://www.imagemagick.org/discourse-server/">Community</a>
<a class="magick-nav-item navbar-right " href="http://www.imagemagick.org/script/search.php">Search</a>
</nav>
</div>
</div>
<div class="container">
<div class="magick-header">
<p class="text-center"><a href="exception.html#AcquireExceptionInfo">AcquireExceptionInfo</a><a href="exception.html#ClearMagickException">ClearMagickException</a><a href="exception.html#CatchException">CatchException</a><a href="exception.html#CloneExceptionInfo">CloneExceptionInfo</a><a href="exception.html#DestroyExceptionInfo">DestroyExceptionInfo</a><a href="exception.html#GetExceptionMessage">GetExceptionMessage</a><a href="exception.html#GetLocaleExceptionMessage">GetLocaleExceptionMessage</a><a href="exception.html#InheritException">InheritException</a><a href="exception.html#InitializeExceptionInfo">InitializeExceptionInfo</a><a href="exception.html#MagickError">MagickError</a><a href="exception.html#MagickFatalError">MagickFatalError</a><a href="exception.html#MagickWarning">MagickWarning</a><a href="exception.html#SetErrorHandler">SetErrorHandler</a><a href="exception.html#SetFatalErrorHandler">SetFatalErrorHandler</a><a href="exception.html#SetWarningHandler">SetWarningHandler</a><a href="exception.html#ThrowException">ThrowException</a></p>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="AcquireExceptionInfo">AcquireExceptionInfo</a></h2>
<p>AcquireExceptionInfo() allocates the ExceptionInfo structure.</p>
<p>The format of the AcquireExceptionInfo method is:</p>
<pre class="text">
ExceptionInfo *AcquireExceptionInfo(void)
</pre>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="ClearMagickException">ClearMagickException</a></h2>
<p>ClearMagickException() clears any exception that may not have been caught yet.</p>
<p>The format of the ClearMagickException method is:</p>
<pre class="text">
ClearMagickException(ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>exception</dt>
<dd>the exception info. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="CatchException">CatchException</a></h2>
<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="text">
CatchException(ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>exception</dt>
<dd>the exception info. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="CloneExceptionInfo">CloneExceptionInfo</a></h2>
<p>CloneExceptionInfo() clones the ExceptionInfo structure.</p>
<p>The format of the CloneExceptionInfo method is:</p>
<pre class="text">
ExceptionInfo *CloneException(ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>exception</dt>
<dd>the exception info. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="DestroyExceptionInfo">DestroyExceptionInfo</a></h2>
<p>DestroyExceptionInfo() deallocates memory associated with an exception.</p>
<p>The format of the DestroyExceptionInfo method is:</p>
<pre class="text">
ExceptionInfo *DestroyExceptionInfo(ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>exception</dt>
<dd>the exception info. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="GetExceptionMessage">GetExceptionMessage</a></h2>
<p>GetExceptionMessage() returns the error message defined by the specified error code.</p>
<p>The format of the GetExceptionMessage method is:</p>
<pre class="text">
char *GetExceptionMessage(const int error)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>error</dt>
<dd>the error code. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="GetLocaleExceptionMessage">GetLocaleExceptionMessage</a></h2>
<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="text">
const char *GetLocaleExceptionMessage(const ExceptionType severity,
const char *tag)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>severity</dt>
<dd>the severity of the exception. </dd>
<dd> </dd>
<dt>tag</dt>
<dd>the message tag. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="InheritException">InheritException</a></h2>
<p>InheritException() inherits an exception from a related exception.</p>
<p>The format of the InheritException method is:</p>
<pre class="text">
InheritException(ExceptionInfo *exception,const ExceptionInfo *relative)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>exception</dt>
<dd>the exception info. </dd>
<dd> </dd>
<dt>relative</dt>
<dd>the related exception info. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="InitializeExceptionInfo">InitializeExceptionInfo</a></h2>
<p>InitializeExceptionInfo() initializes an exception to default values.</p>
<p>The format of the InitializeExceptionInfo method is:</p>
<pre class="text">
InitializeExceptionInfo(ExceptionInfo *exception)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>exception</dt>
<dd>the exception info. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="MagickError">MagickError</a></h2>
<p>MagickError() calls the exception handler methods with an error reason.</p>
<p>The format of the MagickError method is:</p>
<pre class="text">
void MagickError(const ExceptionType error,const char *reason,
const char *description)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>exception</dt>
<dd>Specifies the numeric error category. </dd>
<dd> </dd>
<dt>reason</dt>
<dd>Specifies the reason to display before terminating the program. </dd>
<dd> </dd>
<dt>description</dt>
<dd>Specifies any description to the reason. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="MagickFatalError">MagickFatalError</a></h2>
<p>MagickFatalError() calls the fatal exception handler methods with an error reason.</p>
<p>The format of the MagickError method is:</p>
<pre class="text">
void MagickFatalError(const ExceptionType error,const char *reason,
const char *description)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>exception</dt>
<dd>Specifies the numeric error category. </dd>
<dd> </dd>
<dt>reason</dt>
<dd>Specifies the reason to display before terminating the program. </dd>
<dd> </dd>
<dt>description</dt>
<dd>Specifies any description to the reason. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="MagickWarning">MagickWarning</a></h2>
<p>MagickWarning() calls the warning handler methods with a warning reason.</p>
<p>The format of the MagickWarning method is:</p>
<pre class="text">
void MagickWarning(const ExceptionType warning,const char *reason,
const char *description)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>warning</dt>
<dd>the warning severity. </dd>
<dd> </dd>
<dt>reason</dt>
<dd>Define the reason for the warning. </dd>
<dd> </dd>
<dt>description</dt>
<dd>Describe the warning. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="SetErrorHandler">SetErrorHandler</a></h2>
<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="text">
ErrorHandler SetErrorHandler(ErrorHandler handler)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>handler</dt>
<dd>the method to handle errors. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="SetFatalErrorHandler">SetFatalErrorHandler</a></h2>
<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="text">
ErrorHandler SetErrorHandler(ErrorHandler handler)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>handler</dt>
<dd>the method to handle errors. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="SetWarningHandler">SetWarningHandler</a></h2>
<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="text">
ErrorHandler SetWarningHandler(ErrorHandler handler)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>handler</dt>
<dd>the method to handle warnings. </dd>
<dd> </dd>
</dl>
<h2><a href="http://www.imagemagick.org/api/MagickCore/exception_8c.html" id="ThrowException">ThrowException</a></h2>
<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="text">
MagickBooleanType ThrowException(ExceptionInfo *exception,
const ExceptionType severity,const char *reason,
const char *description)
</pre>
<p>A description of each parameter follows:</p>
<dd>
</dd>
<dd> </dd>
<dl class="dl-horizontal">
<dt>exception</dt>
<dd>the exception info. </dd>
<dd> </dd>
<dt>severity</dt>
<dd>the severity of the exception. </dd>
<dd> </dd>
<dt>reason</dt>
<dd>the reason for the exception. </dd>
<dd> </dd>
<dt>description</dt>
<dd>the exception description. </dd>
<dd> </dd>
</dl>
</div>
<footer class="magick-footer">
<div class="magick-nav-item navbar-left">
<a href="../support.html">Donate</a>
</div>
<p><a href="../sitemap.html">Sitemap</a>
<a href="../links.html">Related</a>
<a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Image Studio</a>
<a href="http://jqmagick.imagemagick.org/">JqMagick</a>
<a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a>
</p>
<p><a href="exception.html#">Back to top</a>
<a href="http://www.imagemagick.org/script/contact.php">Contact Us</a></p>
<p class="small">© 1999-2015 ImageMagick Studio LLC</p>
</footer>
</div><!-- /.container -->
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
<script src="../js/bootstrap.min.js"></script>
<script type="text/javascript">
/* */
(function() {
var s = document.createElement('offline-script'), t = document.getElementsByTagName('offline-script')[0];
s.type = 'text/javascript';
s.async = true;
s.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto';
t.parentNode.insertBefore(s, t);
})();
/* */
</script>
</div>
</body>
</html>