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.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 127 </div>
 128 <div  class="sponsor">
 129   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
 130 </div>
 131 <div  class="sponsor">
 132   <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
 133 </div>
 134 <div  class="sponsor">
 135   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 136 </div>
 137 <div  class="sponsor">
 138   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201001010120 Buchhorn -->
 139 </div>
 140 </div>
 141 </div>
 142 \r
 143 \r
 144 </div>\r
 145 \r
 146 <div class="main">\r
 147 \r
 148 <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>
 149
 150 <h2><a href="http://www.imagemagick.org/api/MagickCore/exception
 151 _8c.html" target="source" name="AcquireExceptionInfo">AcquireExceptionInfo</a></h2>
 152 <div class="doc-section">
 153
 154 <p>AcquireExceptionInfo() allocates the ExceptionInfo structure.</p></ol>
 155
 156 <p>The format of the AcquireExceptionInfo method is:</p>
 157
 158 <pre class="code">
 159   ExceptionInfo *AcquireExceptionInfo(void)
 160 </pre>
 161
 162  </div>
 163 <h2><a href="http://www.imagemagick.org/api/MagickCore/exception
 164 _8c.html" target="source" name="ClearMagickException">ClearMagickException</a></h2>
 165 <div class="doc-section">
 166
 167 <p>ClearMagickException() clears any exception that may not have been caught yet.</p></ol>
 168
 169 <p>The format of the ClearMagickException method is:</p>
 170
 171 <pre class="code">
 172   ClearMagickException(ExceptionInfo *exception)
 173 </pre>
 174
 175 <p>A description of each parameter follows:</p></ol>
 176
 177 <h5>exception</h5>
 178 <ol><p>the exception info.</p></ol>
 179
 180  </div>
 181 <h2><a href="http://www.imagemagick.org/api/MagickCore/exception
 182 _8c.html" target="source" name="CatchException">CatchException</a></h2>
 183 <div class="doc-section">
 184
 185 <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>
 186
 187 <p>The format of the CatchException method is:</p>
 188
 189 <pre class="code">
 190   CatchException(ExceptionInfo *exception)
 191 </pre>
 192
 193 <p>A description of each parameter follows:</p></ol>
 194
 195 <h5>exception</h5>
 196 <ol><p>the exception info.</p></ol>
 197
 198  </div>
 199 <h2><a href="http://www.imagemagick.org/api/MagickCore/exception
 200 _8c.html" target="source" name="DestroyExceptionInfo">DestroyExceptionInfo</a></h2>
 201 <div class="doc-section">
 202
 203 <p>DestroyExceptionInfo() deallocates memory associated with an exception.</p></ol>
 204
 205 <p>The format of the DestroyExceptionInfo method is:</p>
 206
 207 <pre class="code">
 208   ExceptionInfo *DestroyExceptionInfo(ExceptionInfo *exception)
 209 </pre>
 210
 211 <p>A description of each parameter follows:</p></ol>
 212
 213 <h5>exception</h5>
 214 <ol><p>the exception info.</p></ol>
 215
 216  </div>
 217 <h2><a href="http://www.imagemagick.org/api/MagickCore/exception
 218 _8c.html" target="source" name="GetExceptionInfo">GetExceptionInfo</a></h2>
 219 <div class="doc-section">
 220
 221 <p>GetExceptionInfo() initializes an exception to default values.</p></ol>
 222
 223 <p>The format of the GetExceptionInfo method is:</p>
 224
 225 <pre class="code">
 226   GetExceptionInfo(ExceptionInfo *exception)
 227 </pre>
 228
 229 <p>A description of each parameter follows:</p></ol>
 230
 231 <h5>exception</h5>
 232 <ol><p>the exception info.</p></ol>
 233
 234  </div>
 235 <h2><a href="http://www.imagemagick.org/api/MagickCore/exception
 236 _8c.html" target="source" name="GetExceptionMessage">GetExceptionMessage</a></h2>
 237 <div class="doc-section">
 238
 239 <p>GetExceptionMessage() returns the error message defined by the specified error code.</p></ol>
 240
 241 <p>The format of the GetExceptionMessage method is:</p>
 242
 243 <pre class="code">
 244   char *GetExceptionMessage(const int error)
 245 </pre>
 246
 247 <p>A description of each parameter follows:</p></ol>
 248
 249 <h5>error</h5>
 250 <ol><p>the error code.</p></ol>
 251
 252  </div>
 253 <h2><a href="http://www.imagemagick.org/api/MagickCore/exception
 254 _8c.html" target="source" name="GetLocaleExceptionMessage">GetLocaleExceptionMessage</a></h2>
 255 <div class="doc-section">
 256
 257 <p>GetLocaleExceptionMessage() converts a enumerated exception severity and tag to a message in the current locale.</p></ol>
 258
 259 <p>The format of the GetLocaleExceptionMessage method is:</p>
 260
 261 <pre class="code">
 262   const char *GetLocaleExceptionMessage(const ExceptionType severity,
 263     const char *tag)
 264 </pre>
 265
 266 <p>A description of each parameter follows:</p></ol>
 267
 268 <h5>severity</h5>
 269 <ol><p>the severity of the exception.</p></ol>
 270
 271 <h5>tag</h5>
 272 <ol><p>the message tag.</p></ol>
 273
 274  </div>
 275 <h2><a href="http://www.imagemagick.org/api/MagickCore/exception
 276 _8c.html" target="source" name="InheritException">InheritException</a></h2>
 277 <div class="doc-section">
 278
 279 <p>InheritException() inherits an exception from a related exception.</p></ol>
 280
 281 <p>The format of the InheritException method is:</p>
 282
 283 <pre class="code">
 284   InheritException(ExceptionInfo *exception,const ExceptionInfo *relative)
 285 </pre>
 286
 287 <p>A description of each parameter follows:</p></ol>
 288
 289 <h5>exception</h5>
 290 <ol><p>the exception info.</p></ol>
 291
 292 <h5>relative</h5>
 293 <ol><p>the related exception info.</p></ol>
 294
 295  </div>
 296 <h2><a href="http://www.imagemagick.org/api/MagickCore/exception
 297 _8c.html" target="source" name="MagickError">MagickError</a></h2>
 298 <div class="doc-section">
 299
 300 <p>MagickError() calls the exception handler methods with an error reason.</p></ol>
 301
 302 <p>The format of the MagickError method is:</p>
 303
 304 <pre class="code">
 305   void MagickError(const ExceptionType error,const char *reason,
 306     const char *description)
 307 </pre>
 308
 309 <p>A description of each parameter follows:</p></ol>
 310
 311 <h5>exception</h5>
 312 <ol><p>Specifies the numeric error category.</p></ol>
 313
 314 <h5>reason</h5>
 315 <ol><p>Specifies the reason to display before terminating the program.</p></ol>
 316
 317 <h5>description</h5>
 318 <ol><p>Specifies any description to the reason.</p></ol>
 319
 320  </div>
 321 <h2><a href="http://www.imagemagick.org/api/MagickCore/exception
 322 _8c.html" target="source" name="MagickFatalError">MagickFatalError</a></h2>
 323 <div class="doc-section">
 324
 325 <p>MagickFatalError() calls the fatal 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 MagickFatalError(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="MagickWarning">MagickWarning</a></h2>
 348 <div class="doc-section">
 349
 350 <p>MagickWarning() calls the warning handler methods with a warning reason.</p></ol>
 351
 352 <p>The format of the MagickWarning method is:</p>
 353
 354 <pre class="code">
 355   void MagickWarning(const ExceptionType warning,const char *reason,
 356     const char *description)
 357 </pre>
 358
 359 <p>A description of each parameter follows:</p></ol>
 360
 361 <h5>warning</h5>
 362 <ol><p>the warning severity.</p></ol>
 363
 364 <h5>reason</h5>
 365 <ol><p>Define the reason for the warning.</p></ol>
 366
 367 <h5>description</h5>
 368 <ol><p>Describe the warning.</p></ol>
 369
 370  </div>
 371 <h2><a href="http://www.imagemagick.org/api/MagickCore/exception
 372 _8c.html" target="source" name="SetErrorHandler">SetErrorHandler</a></h2>
 373 <div class="doc-section">
 374
 375 <p>SetErrorHandler() sets the exception handler to the specified method and returns the previous exception handler.</p></ol>
 376
 377 <p>The format of the SetErrorHandler method is:</p>
 378
 379 <pre class="code">
 380   ErrorHandler SetErrorHandler(ErrorHandler handler)
 381 </pre>
 382
 383 <p>A description of each parameter follows:</p></ol>
 384
 385 <h5>handler</h5>
 386 <ol><p>the method to handle errors.</p></ol>
 387
 388  </div>
 389 <h2><a href="http://www.imagemagick.org/api/MagickCore/exception
 390 _8c.html" target="source" name="SetFatalErrorHandler">SetFatalErrorHandler</a></h2>
 391 <div class="doc-section">
 392
 393 <p>SetFatalErrorHandler() sets the fatal exception handler to the specified method and returns the previous fatal exception handler.</p></ol>
 394
 395 <p>The format of the SetErrorHandler method is:</p>
 396
 397 <pre class="code">
 398   ErrorHandler SetErrorHandler(ErrorHandler handler)
 399 </pre>
 400
 401 <p>A description of each parameter follows:</p></ol>
 402
 403 <h5>handler</h5>
 404 <ol><p>the method to handle errors.</p></ol>
 405
 406  </div>
 407 <h2><a href="http://www.imagemagick.org/api/MagickCore/exception
 408 _8c.html" target="source" name="SetWarningHandler">SetWarningHandler</a></h2>
 409 <div class="doc-section">
 410
 411 <p>SetWarningHandler() sets the warning handler to the specified method and returns the previous warning handler.</p></ol>
 412
 413 <p>The format of the SetWarningHandler method is:</p>
 414
 415 <pre class="code">
 416   ErrorHandler SetWarningHandler(ErrorHandler handler)
 417 </pre>
 418
 419 <p>A description of each parameter follows:</p></ol>
 420
 421 <h5>handler</h5>
 422 <ol><p>the method to handle warnings.</p></ol>
 423
 424  </div>
 425 <h2><a href="http://www.imagemagick.org/api/MagickCore/exception
 426 _8c.html" target="source" name="ThrowException">ThrowException</a></h2>
 427 <div class="doc-section">
 428
 429 <p>ThrowException() throws an exception with the specified severity code, reason, and optional description.</p></ol>
 430
 431 <p>The format of the ThrowException method is:</p>
 432
 433 <pre class="code">
 434   MagickBooleanType ThrowException(ExceptionInfo *exception,
 435     const ExceptionType severity,const char *reason,
 436     const char *description)
 437 </pre>
 438
 439 <p>A description of each parameter follows:</p></ol>
 440
 441 <h5>exception</h5>
 442 <ol><p>the exception info.</p></ol>
 443
 444 <h5>severity</h5>
 445 <ol><p>the severity of the exception.</p></ol>
 446
 447 <h5>reason</h5>
 448 <ol><p>the reason for the exception.</p></ol>
 449
 450 <h5>description</h5>
 451 <ol><p>the exception description.</p></ol>
 452
 453  </div>
 454 \r
 455 </div>\r
 456 \r
 457 <div id="linkbar">\r
 458  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 459     <span id="linkbar-center">\r
 460       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 461       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
 462     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 463     </span>\r
 464     <span id="linkbar-east">&nbsp;</span>\r
 465   </div>\r
 466   <div class="footer">\r
 467     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
 468     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 469   </div>\r
 470   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 471 </body>\r
 472 </html>\r