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