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