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