Tryag File Manager

//proc/self/root/usr/share/doc/ImageMagick-6.2.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">
<head>
  <style type="text/css"></style>
  <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, PerlMagick, Magick++, Image, Magick"/>
  <meta name="Description" content="ImageMagick (TM) is a free software suite to create, edit and compose bitmap images. It can read, convert and write images in a large variety of formats. Images can be cropped, colors can be changed, various effects can be applied, images can be rotated and combined, and text, lines, polygons, ellipses and Bézier curves can be added to images and stretched and rotated.  ImageMagick is free software: it is delivered with full source code and can be freely used, copied, modified and distributed. Its license is compatible with the GPL. It runs on all major operating systems.  Most of the functionality of ImageMagick can be used interactively from the command line; more often, however, the features are used from programs written in the programming languages Perl, C, C++, Python, PHP, Ruby or Java, for which ready-made ImageMagick interfaces (PerlMagick, Magick++, PythonMagick, MagickWand for PHP, RubyMagick, and JMagick) are available. This makes it possible to modify or create images automatically and dynamically.  ImageMagick supports many image formats (over 90 major formats) including popular formats like TIFF, JPEG, PNG, PDF, PhotoCD, and GIF."/>
  <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-2006 ImageMagick Studio LLC"/>
  <meta name="Distribution" content="Global"/>
  <link rel="shortcut icon" href="/../images/wand.ico"  type="image/x-icon"/>
</head>

<tr valign="top" style="height: 100%;">
      <td id="menu" width="1%" height="100%">
      <p><a href="#main">Skip to page contents</a></p>
      <span>[</span>
      <a href="../../index.html">About ImageMagick</a>
      <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="../../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="../../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#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/links.html">Links</a>
  <span>]</span><br /><br /><span>[</span>
      <a href="../../www/sponsors.html">Sponsors</a>
  <a href="http://larscapes.com/" class="sponsor" target="sponsor">Larscapes</a>
      <span>]</span>
      </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 name="AcquireExceptionInfo">AcquireExceptionInfo</a></h2>
</div>

<p>AcquireExceptionInfo() allocates the ExceptionInfo structure.</p>

<p>The format of the AcquireExceptionInfo method is:</p>

<pre class="code">
  ExceptionInfo *AcquireExceptionInfo(void)
</pre>

<div style="margin: auto;">
  <h2><a name="ClearMagickException">ClearMagickException</a></h2>
</div>

<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>

<h4>exception</h4>
<p>The exception info.</p>

<div style="margin: auto;">
  <h2><a 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>

<p>The format of the CatchException method is:</p>

<pre class="code">
  CatchException(ExceptionInfo *exception)
</pre>

<p>A description of each parameter follows:</p>

<h4>exception</h4>
<p>The exception info.</p>

<div style="margin: auto;">
  <h2><a name="DestroyExceptionInfo">DestroyExceptionInfo</a></h2>
</div>

<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>

<h4>exception</h4>
<p>The exception info.</p>

<div style="margin: auto;">
  <h2><a name="GetExceptionInfo">GetExceptionInfo</a></h2>
</div>

<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>

<h4>exception</h4>
<p>The exception info.</p>

<div style="margin: auto;">
  <h2><a name="GetExceptionMessage">GetExceptionMessage</a></h2>
</div>

<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_code)
</pre>

<p>A description of each parameter follows:</p>

<h4>error_code</h4>
<p>the error code.</p>

<div style="margin: auto;">
  <h2><a name="GetLocaleExceptionMessage">GetLocaleExceptionMessage</a></h2>
</div>

<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>

<h4>severity</h4>
<p>the severity of the exception.</p>

<h4>tag</h4>
<p>the message tag.</p>

<div style="margin: auto;">
  <h2><a name="InheritException">InheritException</a></h2>
</div>

<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>

<h4>exception</h4>
<p>The exception info.</p>

<h4>relative</h4>
<p>The related exception info.</p>

<div style="margin: auto;">
  <h2><a name="MagickError">MagickError</a></h2>
</div>

<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>

<h4>exception</h4>
<p>Specifies the numeric error category.</p>

<h4>reason</h4>
<p>Specifies the reason to display before terminating the program.</p>

<h4>description</h4>
<p>Specifies any description to the reason.</p>

<div style="margin: auto;">
  <h2><a name="MagickFatalError">MagickFatalError</a></h2>
</div>

<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>

<h4>exception</h4>
<p>Specifies the numeric error category.</p>

<h4>reason</h4>
<p>Specifies the reason to display before terminating the program.</p>

<h4>description</h4>
<p>Specifies any description to the reason.</p>

<div style="margin: auto;">
  <h2><a name="MagickWarning">MagickWarning</a></h2>
</div>

<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>

<h4>warning</h4>
<p>The warning severity.</p>

<h4>reason</h4>
<p>Define the reason for the warning.</p>

<h4>description</h4>
<p>Describe the warning.</p>

<div style="margin: auto;">
  <h2><a name="SetErrorHandler">SetErrorHandler</a></h2>
</div>

<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>

<h4>handler</h4>
<p>The method to handle errors.</p>

<div style="margin: auto;">
  <h2><a 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>

<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>

<h4>handler</h4>
<p>The method to handle errors.</p>

<div style="margin: auto;">
  <h2><a name="SetWarningHandler">SetWarningHandler</a></h2>
</div>

<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>

<h4>handler</h4>
<p>The method to handle warnings.</p>

<div style="margin: auto;">
  <h2><a name="ThrowException">ThrowException</a></h2>
</div>

<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>

<h4>exception</h4>
<p>The exception info.</p>

<h4>severity</h4>
<p>The severity of the exception.</p>

<h4>tag</h4>
<p>The message tag.</p>

<h4>description</h4>
<p>The exception description.</p>

</td>
      <td id="margin" width="1%" height="100%" valign="top" align="right">&nbsp;</td>
    </tr>
  </tbody>
  </table>
  <div id="linkbar">
    <a href="http://redux.imagemagick.org/discussion-server" target="2104578057">Discourse Server</a> |
    <a href="../../www/mailing-list.html">Mailing Lists</a> |
    <a href="http://redux.imagemagick.org/gallery" target="139848642">Image Gallery</a> |
    <a href="http://redux.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi" target="921796901">ImageMagick Studio</a>
  </div>
  <div>
    <span id="footer-west">&copy; 1999-2006 ImageMagick Studio LLC</span>
  </div>
  <div style="clear: both; margin: 0; width: 100%; "></div>
</body>
</html>