granicus.if.org Git - imagemagick/blob - www/api/exception.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
   2     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">\r
   4 <head>\r
   5   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
   6   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   7   <style type="text/css" media="screen,projection"><!--\r
   8     @import url("../../www/magick.css");\r
   9   --></style>\r
  10   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  11   <title>ImageMagick: MagickCore, C API for ImageMagick: Dealing with Exceptions</title>
  12   <meta http-equiv="Content-Language" content="en-US"/>
  13   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  14   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  15   <meta name="Generator" content="PHP"/>
  16   <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, Swiss, Army, Knife, Image, Processing"/>
  17   <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."/>
  18   <meta name="Rating" content="GENERAL"/>
  19   <meta name="Robots" content="INDEX, FOLLOW"/>
  20   <meta name="Generator" content="ImageMagick Studio LLC"/>
  21   <meta name="Author" content="ImageMagick Studio LLC"/>
  22   <meta name="Revisit-after" content="2 DAYS"/>
  23   <meta name="Resource-type" content="document"/>
  24   <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
  25   <meta name="Distribution" content="Global"/>
  26 </head>\r
  27 \r
  28 <body id="www-imagemagick-org">\r
  29 <div class="titlebar">\r
  30 <a href="../../index.html">\r
  31   <img src="../../images/script.png" alt="[ImageMagick]"\r
  32   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  33 <a href="http://www.networkredux.com">\r
  34   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  35   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  36 <a href="http://www.imagemagick.org/discourse-server/">\r
  37   <img src="../../images/logo.jpg" alt=""\r
  38   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  39 <a href="../../index.html">\r
  40   <img src="../../images/sprite.jpg" alt=""\r
  41   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  42 </div>\r
  43 \r
  44 <div class="eastbar">\r
  45 \r
  46 <div class="menu">
  47   <a href="../../index.html">About ImageMagick</a>
  48 </div>
  49 <div class="sep"></div>\r
  50 <div class="menu">
  51   <a href="../../www/command-line-tools.html">Command-line Tools</a>
  52 </div>
  53 <div class="sub">
  54     <a href="../../www/command-line-processing.html">Processing</a>
  55 </div>
  56 <div class="sub">
  57     <a href="../../www/command-line-options.html">Options</a>
  58 </div>
  59 <div class="sub">
  60     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  61 </div>
  62 <div class="menu">
  63   <a href="../../www/api.html">Program Interfaces</a>
  64 </div>
  65 <div class="sub">
  66     <a href="../../www/magick-wand.html">MagickWand</a>
  67 </div>
  68 <div class="sub">
  69     <a href="../../www/magick-core.html">MagickCore</a>
  70 </div>
  71 <div class="sub">
  72     <a href="../../www/perl-magick.html">PerlMagick</a>
  73 </div>
  74 <div class="sub">
  75     <a href="../../Magick++/">Magick++</a>
  76 </div>
  77 <div class="menu">
  78   <a href="../../www/architecture.html">Architecture</a>
  79 </div>
  80 <div class="sep"></div>\r
  81 <div  class="menu">
  82    <a href="../../www/install-source.html">Install from Source</a>
  83 </div>
  84 <div class="sub">
  85     <a href="../../www/install-source.html#unix">Unix</a>
  86 </div>
  87 <div class="sub">
  88     <a href="../../www/install-source.html#windows">Windows</a>
  89  </div>
  90 <div class="menu">
  91   <a href="../../www/binary-releases.html">Binary Releases</a>
  92 </div>
  93 <div class="sub">
  94     <a href="../../www/binary-releases.html#unix">Unix</a>
  95 </div>
  96 <div class="sub">
  97     <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
  98 </div>
  99 <div class="sub">
 100     <a href="../../www/binary-releases.html#windows">Windows</a>
 101 </div>
 102 <div class="menu">
 103   <a href="../../www/resources.html">Resources</a>
 104 </div>
 105 <div class="sep"></div>\r
 106 <div class="menu">
 107   <a href="../../www/download.html">Download</a>
 108 </div>
 109 <div class="sep"></div>\r
 110 <div class="menu">
 111   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
 112 </div>
 113 <div class="sep"></div>\r
 114 <div class="menu">
 115   <a href="../../www/sitemap.html">Site Map</a>
 116 </div>
 117 <div  class="sub">
 118     <a href="../../www/links.html">Links</a>
 119 </div>
 120 <div class="sep"></div>\r
 121 <div  class="menu">
 122   <a href="../../www/sponsors.html">Sponsors:</a>
 123
 124 <div class="sponsbox">
 125 <div  class="sponsor">
 126    <a href="http://www.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20090501000200 -->
 127 </div>
 128 <div  class="sponsor">
 129   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201003010120 Buchhorn -->
 130 </div>
 131 <div  class="sponsor">
 132   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 133 </div>
 134 <div  class="sponsor">
 135    <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
 136 </div>
 137 <div  class="sponsor">
 138    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 139 </div>
 140 <div  class="sponsor">
 141   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
 142 </div>
 143 <div  class="sponsor">
 144   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 145 </div>
 146 </div>
 147 </div>
 148 \r
 149 \r
 150 </div>\r
 151 \r
 152 <div class="main">\r
 153 \r
 154 <p class="navigation-index">[<a href="#AcquireExceptionInfo">AcquireExceptionInfo</a> &bull; <a href="#ClearMagickException">ClearMagickException</a> &bull; <a href="#CatchException">CatchException</a> &bull; <a href="#DestroyExceptionInfo">DestroyExceptionInfo</a> &bull; <a href="#GetExceptionInfo">GetExceptionInfo</a> &bull; <a href="#GetExceptionMessage">GetExceptionMessage</a> &bull; <a href="#GetLocaleExceptionMessage">GetLocaleExceptionMessage</a> &bull; <a href="#InheritException">InheritException</a> &bull; <a href="#MagickError">MagickError</a> &bull; <a href="#MagickFatalError">MagickFatalError</a> &bull; <a href="#MagickWarning">MagickWarning</a> &bull; <a href="#SetErrorHandler">SetErrorHandler</a> &bull; <a href="#SetFatalErrorHandler">SetFatalErrorHandler</a> &bull; <a href="#SetWarningHandler">SetWarningHandler</a> &bull; <a href="#ThrowException">ThrowException</a>]</p>
 155
 156 <h2><a href="http://www.imagemagick.org/api/MagickCore/exception
 157 _8c.html" target="source" name="AcquireExceptionInfo">AcquireExceptionInfo</a></h2>
 158 <div class="doc-section">
 159
 160 <p>AcquireExceptionInfo() allocates the ExceptionInfo structure.</p></ol>
 161
 162 <p>The format of the AcquireExceptionInfo method is:</p>
 163
 164 <pre class="code">
 165   ExceptionInfo *AcquireExceptionInfo(void)
 166 </pre>
 167
 168  </div>
 169 <h2><a href="http://www.imagemagick.org/api/MagickCore/exception
 170 _8c.html" target="source" name="ClearMagickException">ClearMagickException</a></h2>
 171 <div class="doc-section">
 172
 173 <p>ClearMagickException() clears any exception that may not have been caught yet.</p></ol>
 174
 175 <p>The format of the ClearMagickException method is:</p>
 176
 177 <pre class="code">
 178   ClearMagickException(ExceptionInfo *exception)
 179 </pre>
 180
 181 <p>A description of each parameter follows:</p></ol>
 182
 183 <h5>exception</h5>
 184 <ol><p>the exception info.</p></ol>
 185
 186  </div>
 187 <h2><a href="http://www.imagemagick.org/api/MagickCore/exception
 188 _8c.html" target="source" name="CatchException">CatchException</a></h2>
 189 <div class="doc-section">
 190
 191 <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>
 192
 193 <p>The format of the CatchException method is:</p>
 194
 195 <pre class="code">
 196   CatchException(ExceptionInfo *exception)
 197 </pre>
 198
 199 <p>A description of each parameter follows:</p></ol>
 200
 201 <h5>exception</h5>
 202 <ol><p>the exception info.</p></ol>
 203
 204  </div>
 205 <h2><a href="http://www.imagemagick.org/api/MagickCore/exception
 206 _8c.html" target="source" name="DestroyExceptionInfo">DestroyExceptionInfo</a></h2>
 207 <div class="doc-section">
 208
 209 <p>DestroyExceptionInfo() deallocates memory associated with an exception.</p></ol>
 210
 211 <p>The format of the DestroyExceptionInfo method is:</p>
 212
 213 <pre class="code">
 214   ExceptionInfo *DestroyExceptionInfo(ExceptionInfo *exception)
 215 </pre>
 216
 217 <p>A description of each parameter follows:</p></ol>
 218
 219 <h5>exception</h5>
 220 <ol><p>the exception info.</p></ol>
 221
 222  </div>
 223 <h2><a href="http://www.imagemagick.org/api/MagickCore/exception
 224 _8c.html" target="source" name="GetExceptionInfo">GetExceptionInfo</a></h2>
 225 <div class="doc-section">
 226
 227 <p>GetExceptionInfo() initializes an exception to default values.</p></ol>
 228
 229 <p>The format of the GetExceptionInfo method is:</p>
 230
 231 <pre class="code">
 232   GetExceptionInfo(ExceptionInfo *exception)
 233 </pre>
 234
 235 <p>A description of each parameter follows:</p></ol>
 236
 237 <h5>exception</h5>
 238 <ol><p>the exception info.</p></ol>
 239
 240  </div>
 241 <h2><a href="http://www.imagemagick.org/api/MagickCore/exception
 242 _8c.html" target="source" name="GetExceptionMessage">GetExceptionMessage</a></h2>
 243 <div class="doc-section">
 244
 245 <p>GetExceptionMessage() returns the error message defined by the specified error code.</p></ol>
 246
 247 <p>The format of the GetExceptionMessage method is:</p>
 248
 249 <pre class="code">
 250   char *GetExceptionMessage(const int error)
 251 </pre>
 252
 253 <p>A description of each parameter follows:</p></ol>
 254
 255 <h5>error</h5>
 256 <ol><p>the error code.</p></ol>
 257
 258  </div>
 259 <h2><a href="http://www.imagemagick.org/api/MagickCore/exception
 260 _8c.html" target="source" name="GetLocaleExceptionMessage">GetLocaleExceptionMessage</a></h2>
 261 <div class="doc-section">
 262
 263 <p>GetLocaleExceptionMessage() converts a enumerated exception severity and tag to a message in the current locale.</p></ol>
 264
 265 <p>The format of the GetLocaleExceptionMessage method is:</p>
 266
 267 <pre class="code">
 268   const char *GetLocaleExceptionMessage(const ExceptionType severity,
 269     const char *tag)
 270 </pre>
 271
 272 <p>A description of each parameter follows:</p></ol>
 273
 274 <h5>severity</h5>
 275 <ol><p>the severity of the exception.</p></ol>
 276
 277 <h5>tag</h5>
 278 <ol><p>the message tag.</p></ol>
 279
 280  </div>
 281 <h2><a href="http://www.imagemagick.org/api/MagickCore/exception
 282 _8c.html" target="source" name="InheritException">InheritException</a></h2>
 283 <div class="doc-section">
 284
 285 <p>InheritException() inherits an exception from a related exception.</p></ol>
 286
 287 <p>The format of the InheritException method is:</p>
 288
 289 <pre class="code">
 290   InheritException(ExceptionInfo *exception,const ExceptionInfo *relative)
 291 </pre>
 292
 293 <p>A description of each parameter follows:</p></ol>
 294
 295 <h5>exception</h5>
 296 <ol><p>the exception info.</p></ol>
 297
 298 <h5>relative</h5>
 299 <ol><p>the related exception info.</p></ol>
 300
 301  </div>
 302 <h2><a href="http://www.imagemagick.org/api/MagickCore/exception
 303 _8c.html" target="source" name="MagickError">MagickError</a></h2>
 304 <div class="doc-section">
 305
 306 <p>MagickError() calls the exception handler methods with an error reason.</p></ol>
 307
 308 <p>The format of the MagickError method is:</p>
 309
 310 <pre class="code">
 311   void MagickError(const ExceptionType error,const char *reason,
 312     const char *description)
 313 </pre>
 314
 315 <p>A description of each parameter follows:</p></ol>
 316
 317 <h5>exception</h5>
 318 <ol><p>Specifies the numeric error category.</p></ol>
 319
 320 <h5>reason</h5>
 321 <ol><p>Specifies the reason to display before terminating the program.</p></ol>
 322
 323 <h5>description</h5>
 324 <ol><p>Specifies any description to the reason.</p></ol>
 325
 326  </div>
 327 <h2><a href="http://www.imagemagick.org/api/MagickCore/exception
 328 _8c.html" target="source" name="MagickFatalError">MagickFatalError</a></h2>
 329 <div class="doc-section">
 330
 331 <p>MagickFatalError() calls the fatal exception handler methods with an error reason.</p></ol>
 332
 333 <p>The format of the MagickError method is:</p>
 334
 335 <pre class="code">
 336   void MagickFatalError(const ExceptionType error,const char *reason,
 337     const char *description)
 338 </pre>
 339
 340 <p>A description of each parameter follows:</p></ol>
 341
 342 <h5>exception</h5>
 343 <ol><p>Specifies the numeric error category.</p></ol>
 344
 345 <h5>reason</h5>
 346 <ol><p>Specifies the reason to display before terminating the program.</p></ol>
 347
 348 <h5>description</h5>
 349 <ol><p>Specifies any description to the reason.</p></ol>
 350
 351  </div>
 352 <h2><a href="http://www.imagemagick.org/api/MagickCore/exception
 353 _8c.html" target="source" name="MagickWarning">MagickWarning</a></h2>
 354 <div class="doc-section">
 355
 356 <p>MagickWarning() calls the warning handler methods with a warning reason.</p></ol>
 357
 358 <p>The format of the MagickWarning method is:</p>
 359
 360 <pre class="code">
 361   void MagickWarning(const ExceptionType warning,const char *reason,
 362     const char *description)
 363 </pre>
 364
 365 <p>A description of each parameter follows:</p></ol>
 366
 367 <h5>warning</h5>
 368 <ol><p>the warning severity.</p></ol>
 369
 370 <h5>reason</h5>
 371 <ol><p>Define the reason for the warning.</p></ol>
 372
 373 <h5>description</h5>
 374 <ol><p>Describe the warning.</p></ol>
 375
 376  </div>
 377 <h2><a href="http://www.imagemagick.org/api/MagickCore/exception
 378 _8c.html" target="source" name="SetErrorHandler">SetErrorHandler</a></h2>
 379 <div class="doc-section">
 380
 381 <p>SetErrorHandler() sets the exception handler to the specified method and returns the previous exception handler.</p></ol>
 382
 383 <p>The format of the SetErrorHandler method is:</p>
 384
 385 <pre class="code">
 386   ErrorHandler SetErrorHandler(ErrorHandler handler)
 387 </pre>
 388
 389 <p>A description of each parameter follows:</p></ol>
 390
 391 <h5>handler</h5>
 392 <ol><p>the method to handle errors.</p></ol>
 393
 394  </div>
 395 <h2><a href="http://www.imagemagick.org/api/MagickCore/exception
 396 _8c.html" target="source" name="SetFatalErrorHandler">SetFatalErrorHandler</a></h2>
 397 <div class="doc-section">
 398
 399 <p>SetFatalErrorHandler() sets the fatal exception handler to the specified method and returns the previous fatal exception handler.</p></ol>
 400
 401 <p>The format of the SetErrorHandler method is:</p>
 402
 403 <pre class="code">
 404   ErrorHandler SetErrorHandler(ErrorHandler handler)
 405 </pre>
 406
 407 <p>A description of each parameter follows:</p></ol>
 408
 409 <h5>handler</h5>
 410 <ol><p>the method to handle errors.</p></ol>
 411
 412  </div>
 413 <h2><a href="http://www.imagemagick.org/api/MagickCore/exception
 414 _8c.html" target="source" name="SetWarningHandler">SetWarningHandler</a></h2>
 415 <div class="doc-section">
 416
 417 <p>SetWarningHandler() sets the warning handler to the specified method and returns the previous warning handler.</p></ol>
 418
 419 <p>The format of the SetWarningHandler method is:</p>
 420
 421 <pre class="code">
 422   ErrorHandler SetWarningHandler(ErrorHandler handler)
 423 </pre>
 424
 425 <p>A description of each parameter follows:</p></ol>
 426
 427 <h5>handler</h5>
 428 <ol><p>the method to handle warnings.</p></ol>
 429
 430  </div>
 431 <h2><a href="http://www.imagemagick.org/api/MagickCore/exception
 432 _8c.html" target="source" name="ThrowException">ThrowException</a></h2>
 433 <div class="doc-section">
 434
 435 <p>ThrowException() throws an exception with the specified severity code, reason, and optional description.</p></ol>
 436
 437 <p>The format of the ThrowException method is:</p>
 438
 439 <pre class="code">
 440   MagickBooleanType ThrowException(ExceptionInfo *exception,
 441     const ExceptionType severity,const char *reason,
 442     const char *description)
 443 </pre>
 444
 445 <p>A description of each parameter follows:</p></ol>
 446
 447 <h5>exception</h5>
 448 <ol><p>the exception info.</p></ol>
 449
 450 <h5>severity</h5>
 451 <ol><p>the severity of the exception.</p></ol>
 452
 453 <h5>reason</h5>
 454 <ol><p>the reason for the exception.</p></ol>
 455
 456 <h5>description</h5>
 457 <ol><p>the exception description.</p></ol>
 458
 459  </div>
 460 \r
 461 </div>\r
 462 \r
 463 <div id="linkbar">\r
 464  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 465     <span id="linkbar-center">\r
 466       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 467       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
 468     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 469     </span>\r
 470     <span id="linkbar-east">&nbsp;</span>\r
 471   </div>\r
 472   <div class="footer">\r
 473     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
 474     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 475   </div>\r
 476   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 477 </body>\r
 478 </html>\r