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

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