| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="-//W3C//DTD XHTML 1.1//EN" xml:lang="en" 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> |
| <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4"></meta> |
| <title>ImageMagick: MagickCore, C API for ImageMagick: Dealing with Exceptions</title> |
| <meta http-equiv="content-language" content="en-US"></meta> |
| <meta http-equiv="content-type" content="text/html; charset=utf-8"></meta> |
| <meta http-equiv="reply-to" content="magick-users@imagemagick.org"></meta> |
| <meta name="application-name" content="ImageMagick"></meta> |
| <meta name="description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition, resize, rotate, shear, distort or transform images automagically."></meta> |
| <meta name="application-url" content="http://www.imagemagick.org"></meta> |
| <meta name="generator" content="PHP"></meta> |
| <meta name="keywords" content="magickcore, c, api, for, imagemagick:, dealing, with, exceptions, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"></meta> |
| <meta name="rating" content="GENERAL"></meta> |
| <meta name="robots" content="INDEX, FOLLOW"></meta> |
| <meta name="generator" content="ImageMagick Studio LLC"></meta> |
| <meta name="author" content="ImageMagick Studio LLC"></meta> |
| <meta name="revisit-after" content="2 DAYS"></meta> |
| <meta name="resource-type" content="document"></meta> |
| <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"></meta> |
| <meta name="distribution" content="Global"></meta> |
| <link rel="icon" href="../../images/wand.png"></link> |
| <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"></link> |
| <link rel="canonical" href="../../index.html"></link> |
| <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"></link> |
| |
| <!-- Add jQuery library --> |
| <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script> |
| |
| <!-- Add mousewheel plugin (this is optional) --> |
| <script type="text/javascript" src="http://www.imagemagick.org/fancybox/lib/jquery.mousewheel-3.0.6.pack.js"></script> |
| |
| <!-- Add fancyBox --> |
| <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/jquery.fancybox.css?v=2.0.6" type="text/css" media="screen"></link> |
| <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/jquery.fancybox.pack.js?v=2.0.6"></script> |
| |
| <!-- Optionally add helpers - button, thumbnail and/or media --> |
| <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.css?v=1.0.2" type="text/css" media="screen"></link> |
| <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.js?v=1.0.2"></script> |
| <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-media.js?v=1.0.0"></script> |
| |
| <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.css?v=2.0.6" type="text/css" media="screen"></link> |
| <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.js?v=2.0.6"></script> |
| |
| <script type="text/javascript"> |
| $(document).ready(function() { |
| $(".fancybox").fancybox(); |
| }); |
| </script> |
| |
| <!-- ImageMagick style --> |
| <style type="text/css" media="all"> |
| @import url("../../www/magick.css"); |
| </style> |
| </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> |
| |
| </div> |
| <a href="../../discourse-server"> |
| <img src="../../images/logo.jpg" alt="ImageMagick Logo" style="width: 123px; height: 118px; border: 0px; float: right;"></img></a> |
| <a href="../../index.html"> |
| <img src="../../images/sprite.jpg" alt="ImageMagick Sprite" style="width: 114px; height: 118px; border: 0px; float: right;"></img></a> |
| </div> |
| |
| <div class="westbar"> |
| |
| <div class="menu"> |
| <a title="About ImageMagick" href="../../index.html">About ImageMagick</a> |
| </div> |
| <div class="menu"> |
| <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a> |
| </div> |
| <div class="sub"> |
| <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a> |
| </div> |
| <div class="sub"> |
| <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a> |
| </div> |
| <div class="sub"> |
| <a title="Binary Release: iOS" href="../../www/binary-releases.html#iOS">iOS</a> |
| </div> |
| <div class="sub"> |
| <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a> |
| </div> |
| <div class="sep"></div> |
| <div class="menu"> |
| <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a> |
| </div> |
| <div class="sub"> |
| <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a> |
| </div> |
| <div class="sub"> |
| <a title="Command-line Tools: Options" href="../../www/command-line-options.html">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="../../www/api.html">Program Interfaces</a> |
| </div> |
| <div class="sub"> |
| <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a> |
| </div> |
| <div class="sub"> |
| <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a> |
| </div> |
| <div class="sub"> |
| <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a> |
| </div> |
| <div class="sub"> |
| <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a> |
| </div> |
| <div class="sep"></div> |
| <div class="menu"> |
| <a title="Install from Source" href="../../www/install-source.html">Install from Source</a> |
| </div> |
| <div class="sub"> |
| <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a> |
| </div> |
| <div class="sub"> |
| <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a> |
| </div> |
| <div class="menu"> |
| <a title="Resources" href="../../www/resources.html">Resources</a> |
| </div> |
| <div class="menu"> |
| <a title="Architecture" href="../../www/architecture.html">Architecture</a> |
| </div> |
| <div class="menu"> |
| <a title="Download" href="../../www/download.html">Download</a> |
| </div> |
| <div class="sep"></div> |
| <div class="menu"> |
| <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a> |
| </div> |
| <div class="sep"></div> |
| <div class="menu"> |
| <a title="Site Map" href="../../www/sitemap.html">Site Map</a> |
| </div> |
| <div class="sub"> |
| <a title="Site Map: Links" href="../../www/links.html">Links</a> |
| </div> |
| <div class="sep"></div> |
| <div class="menu"> |
| <a title="Support ImageMagick Development" href="../../www/support.html">Support ImageMagick Development</a> |
| </div> |
| </div> |
| |
| <div class="eastbar"> |
| |
| <div> <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="../../index.html"></a></div> |
| <noscript> |
| <a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank"> |
| <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" width="93" height="20" border="0"></img></a> |
| </noscript> |
| |
| |
| </div> |
| |
| <div class="main"> |
| |
| <h1>Module exception Methods</h1> |
| <p class="navigation-index">[<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#DestroyExceptionInfo">DestroyExceptionInfo</a> • <a href="exception.html#GetExceptionInfo">GetExceptionInfo</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#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> |
| <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"> </span> |
| |
| <span id="linkbar-center"> |
| <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> • |
| <a href="../../discourse-server">Discourse Server</a> • |
| <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a> • |
| <a href="http://jqmagick.imagemagick.org/">JqMagick</a> |
| </span> |
| <span id="linkbar-east"> </span> |
| </div> |
| <div class="footer"> |
| <span id="footer-west">© 1999-2013 ImageMagick Studio LLC</span> |
| <span id="footer-east"> <a href="../../www/contact.html">Contact the Wizards</a></span> |
| </div> |
| <div style="clear: both; margin: 0; width: 100%; "></div> |
| </body> |
| </html> |