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