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