exception.html 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518
  1. <!doctype html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1" />
  6. <title>ImageMagick – MagickCore, C API: Dealing with Exceptions</title>
  7. <meta name="application-name" content="ImageMagick" />
  8. <meta name="description" content="" />
  9. <meta name="application-url" content="https://imagemagick.org" />
  10. <meta name="generator" content="PHP" />
  11. <meta name="keywords" content="magickcore, c, api:, dealing, with, exceptions, image processing software" />
  12. <meta name="rating" content="GENERAL" />
  13. <meta name="robots" content="INDEX, FOLLOW" />
  14. <meta name="generator" content="ImageMagick Studio LLC" />
  15. <meta name="author" content="ImageMagick Studio LLC" />
  16. <meta name="revisit-after" content="2 DAYS" />
  17. <meta name="resource-type" content="document" />
  18. <meta name="copyright" content="Copyright (c) 1999 ImageMagick Studio LLC" />
  19. <meta name="distribution" content="Global" />
  20. <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1" />
  21. <meta property='og:url' content='../../' />
  22. <meta property='og:title' content='ImageMagick' />
  23. <meta property='og:image' content='../../../images/logo.png' />
  24. <meta property='og:type' content='website' />
  25. <meta property='og:site_name' content='ImageMagick' />
  26. <meta property='og:description' content="Create, Edit, Compose, or Convert Digital Images" />
  27. <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
  28. <link href="exception.html" rel="canonical" />
  29. <link href="../../../images/wand.png" rel="icon" />
  30. <link href="../../../images/wand.ico" rel="shortcut icon" />
  31. <link href="../../assets/magick.css" rel="stylesheet" />
  32. </head>
  33. <body>
  34. <nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top">
  35. <div class="container-fluid">
  36. <a class="navbar-brand" href="../../"><img class="d-block" id="icon" alt="ImageMagick" width="32" height="32" src="../../../images/wand.ico"/></a>
  37. <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#magick-navbars" aria-controls="magick-navbars" aria-expanded="false" aria-label="Toggle navigation">
  38. <span class="navbar-toggler-icon"></span>
  39. </button>
  40. <div class="collapse navbar-collapse" id="magick-navbars">
  41. <ul class="navbar-nav me-auto mb-2 mb-md-0">
  42. <li class="nav-item">
  43. <a class="nav-link " href="../../www/download.html">Download</a>
  44. </li>
  45. <li class="nav-item">
  46. <a class="nav-link " href="../../www/command-line-tools.html">Tools</a>
  47. </li>
  48. <li class="nav-item">
  49. <a class="nav-link " href="../../www/command-line-processing.html">CLI</a>
  50. </li>
  51. <li class="nav-item">
  52. <a class="nav-link " href="../../www/develop.html">Develop</a>
  53. </li>
  54. <li class="nav-item">
  55. <a class="nav-link" target="_blank" href="https://github.com/ImageMagick/ImageMagick/discussions">Community</a>
  56. </li>
  57. <li class="nav-item">
  58. <iframe src="https://github.com/sponsors/ImageMagick/button" title="Sponsor ImageMagick" height="35" width="107" style="border: 0;"></iframe>
  59. </li>
  60. </ul>
  61. <form class="d-flex form-inline" action="https://imagemagick.org/script/search.php">
  62. <input class="form-control me-2" type="text" name="q" placeholder="Search" aria-label="Search">
  63. <button class="btn btn-outline-success" type="submit" name="sa">Search</button>
  64. </form>
  65. </div>
  66. </div>
  67. </nav>
  68. <div class="container">
  69. <script async="async" src="https://localhost/pagead/js/adsbygoogle.js"></script>
  70. <ins class="adsbygoogle"
  71. style="display:block"
  72. data-ad-client="ca-pub-3129977114552745"
  73. data-ad-slot="6345125851"
  74. data-full-width-responsive="true"
  75. data-ad-format="horizontal"></ins>
  76. <script>
  77. (adsbygoogle = window.adsbygoogle || []).push({});
  78. </script>
  79. </div>
  80. <main class="container">
  81. <div class="magick-template">
  82. <br/>
  83. <div class="btn-group">
  84. <button class="btn btn-secondary dropdown-toggle" type="button" id="defaultDropdown" data-bs-toggle="dropdown" data-bs-auto-close="true" aria-expanded="false">
  85. Select API Method
  86. </button>
  87. <ul class="dropdown-menu pre-scrollable" aria-labelledby="defaultDropdown">
  88. <li><a href="exception.html#AcquireExceptionInfo">AcquireExceptionInfo</a></li>
  89. <li><a href="exception.html#ClearMagickException">ClearMagickException</a></li>
  90. <li><a href="exception.html#CatchException">CatchException</a></li>
  91. <li><a href="exception.html#CloneExceptionInfo">CloneExceptionInfo</a></li>
  92. <li><a href="exception.html#DestroyExceptionInfo">DestroyExceptionInfo</a></li>
  93. <li><a href="exception.html#GetExceptionMessage">GetExceptionMessage</a></li>
  94. <li><a href="exception.html#GetLocaleExceptionMessage">GetLocaleExceptionMessage</a></li>
  95. <li><a href="exception.html#InheritException">InheritException</a></li>
  96. <li><a href="exception.html#InitializeExceptionInfo">InitializeExceptionInfo</a></li>
  97. <li><a href="exception.html#MagickError">MagickError</a></li>
  98. <li><a href="exception.html#MagickFatalError">MagickFatalError</a></li>
  99. <li><a href="exception.html#MagickWarning">MagickWarning</a></li>
  100. <li><a href="exception.html#SetErrorHandler">SetErrorHandler</a></li>
  101. <li><a href="exception.html#SetFatalErrorHandler">SetFatalErrorHandler</a></li>
  102. <li><a href="exception.html#SetWarningHandler">SetWarningHandler</a></li>
  103. </ul>
  104. </div>
  105. <br/>
  106. <br/>
  107. <div class="magick-header">
  108. <h2><a href="../../api/MagickCore/exception_8c.html" id="AcquireExceptionInfo">AcquireExceptionInfo</a></h2>
  109. <p>AcquireExceptionInfo() allocates the ExceptionInfo structure.</p>
  110. <p>The format of the AcquireExceptionInfo method is:</p>
  111. <pre class="bg-light text-dark mx-4"><samp>ExceptionInfo *AcquireExceptionInfo(void)
  112. </samp></pre>
  113. <h2><a href="../../api/MagickCore/exception_8c.html" id="ClearMagickException">ClearMagickException</a></h2>
  114. <p>ClearMagickException() clears any exception that may not have been caught yet.</p>
  115. <p>The format of the ClearMagickException method is:</p>
  116. <pre class="bg-light text-dark mx-4"><samp>ClearMagickException(ExceptionInfo *exception)
  117. </samp></pre>
  118. <p>A description of each parameter follows:</p>
  119. <dd>
  120. </dd>
  121. <dd> </dd>
  122. <dl class="dl-horizontal">
  123. <dt>exception</dt>
  124. <dd>the exception info. </dd>
  125. <dd> </dd>
  126. </dl>
  127. <h2><a href="../../api/MagickCore/exception_8c.html" id="CatchException">CatchException</a></h2>
  128. <p>CatchException() returns if no exceptions is found otherwise it reports the exception as a warning, error, or fatal depending on the severity.</p>
  129. <p>The format of the CatchException method is:</p>
  130. <pre class="bg-light text-dark mx-4"><samp>CatchException(ExceptionInfo *exception)
  131. </samp></pre>
  132. <p>A description of each parameter follows:</p>
  133. <dd>
  134. </dd>
  135. <dd> </dd>
  136. <dl class="dl-horizontal">
  137. <dt>exception</dt>
  138. <dd>the exception info. </dd>
  139. <dd> </dd>
  140. </dl>
  141. <h2><a href="../../api/MagickCore/exception_8c.html" id="CloneExceptionInfo">CloneExceptionInfo</a></h2>
  142. <p>CloneExceptionInfo() clones the ExceptionInfo structure.</p>
  143. <p>The format of the CloneExceptionInfo method is:</p>
  144. <pre class="bg-light text-dark mx-4"><samp>ExceptionInfo *CloneException(ExceptionInfo *exception)
  145. </samp></pre>
  146. <p>A description of each parameter follows:</p>
  147. <dd>
  148. </dd>
  149. <dd> </dd>
  150. <dl class="dl-horizontal">
  151. <dt>exception</dt>
  152. <dd>the exception info. </dd>
  153. <dd> </dd>
  154. </dl>
  155. <h2><a href="../../api/MagickCore/exception_8c.html" id="DestroyExceptionInfo">DestroyExceptionInfo</a></h2>
  156. <p>DestroyExceptionInfo() deallocates memory associated with an exception.</p>
  157. <p>The format of the DestroyExceptionInfo method is:</p>
  158. <pre class="bg-light text-dark mx-4"><samp>ExceptionInfo *DestroyExceptionInfo(ExceptionInfo *exception)
  159. </samp></pre>
  160. <p>A description of each parameter follows:</p>
  161. <dd>
  162. </dd>
  163. <dd> </dd>
  164. <dl class="dl-horizontal">
  165. <dt>exception</dt>
  166. <dd>the exception info. </dd>
  167. <dd> </dd>
  168. </dl>
  169. <h2><a href="../../api/MagickCore/exception_8c.html" id="GetExceptionMessage">GetExceptionMessage</a></h2>
  170. <p>GetExceptionMessage() returns the error message defined by the specified error code.</p>
  171. <p>The format of the GetExceptionMessage method is:</p>
  172. <pre class="bg-light text-dark mx-4"><samp>char *GetExceptionMessage(const int error)
  173. </samp></pre>
  174. <p>A description of each parameter follows:</p>
  175. <dd>
  176. </dd>
  177. <dd> </dd>
  178. <dl class="dl-horizontal">
  179. <dt>error</dt>
  180. <dd>the error code. </dd>
  181. <dd> </dd>
  182. </dl>
  183. <h2><a href="../../api/MagickCore/exception_8c.html" id="GetLocaleExceptionMessage">GetLocaleExceptionMessage</a></h2>
  184. <p>GetLocaleExceptionMessage() converts a enumerated exception severity and tag to a message in the current locale.</p>
  185. <p>The format of the GetLocaleExceptionMessage method is:</p>
  186. <pre class="bg-light text-dark mx-4"><samp>const char *GetLocaleExceptionMessage(const ExceptionType severity,
  187. const char *tag)
  188. </samp></pre>
  189. <p>A description of each parameter follows:</p>
  190. <dd>
  191. </dd>
  192. <dd> </dd>
  193. <dl class="dl-horizontal">
  194. <dt>severity</dt>
  195. <dd>the severity of the exception. </dd>
  196. <dd> </dd>
  197. <dt>tag</dt>
  198. <dd>the message tag. </dd>
  199. <dd> </dd>
  200. </dl>
  201. <h2><a href="../../api/MagickCore/exception_8c.html" id="InheritException">InheritException</a></h2>
  202. <p>InheritException() inherits an exception from a related exception.</p>
  203. <p>The format of the InheritException method is:</p>
  204. <pre class="bg-light text-dark mx-4"><samp>InheritException(ExceptionInfo *exception,const ExceptionInfo *relative)
  205. </samp></pre>
  206. <p>A description of each parameter follows:</p>
  207. <dd>
  208. </dd>
  209. <dd> </dd>
  210. <dl class="dl-horizontal">
  211. <dt>exception</dt>
  212. <dd>the exception info. </dd>
  213. <dd> </dd>
  214. <dt>relative</dt>
  215. <dd>the related exception info. </dd>
  216. <dd> </dd>
  217. </dl>
  218. <h2><a href="../../api/MagickCore/exception_8c.html" id="InitializeExceptionInfo">InitializeExceptionInfo</a></h2>
  219. <p>InitializeExceptionInfo() initializes an exception to default values.</p>
  220. <p>The format of the InitializeExceptionInfo method is:</p>
  221. <pre class="bg-light text-dark mx-4"><samp>InitializeExceptionInfo(ExceptionInfo *exception)
  222. </samp></pre>
  223. <p>A description of each parameter follows:</p>
  224. <dd>
  225. </dd>
  226. <dd> </dd>
  227. <dl class="dl-horizontal">
  228. <dt>exception</dt>
  229. <dd>the exception info. </dd>
  230. <dd> </dd>
  231. </dl>
  232. <h2><a href="../../api/MagickCore/exception_8c.html" id="MagickError">MagickError</a></h2>
  233. <p>MagickError() calls the exception handler methods with an error reason.</p>
  234. <p>The format of the MagickError method is:</p>
  235. <pre class="bg-light text-dark mx-4"><samp>void MagickError(const ExceptionType error,const char *reason,
  236. const char *description)
  237. </samp></pre>
  238. <p>A description of each parameter follows:</p>
  239. <dd>
  240. </dd>
  241. <dd> </dd>
  242. <dl class="dl-horizontal">
  243. <dt>exception</dt>
  244. <dd>Specifies the numeric error category. </dd>
  245. <dd> </dd>
  246. <dt>reason</dt>
  247. <dd>Specifies the reason to display before terminating the program. </dd>
  248. <dd> </dd>
  249. <dt>description</dt>
  250. <dd>Specifies any description to the reason. </dd>
  251. <dd> </dd>
  252. </dl>
  253. <h2><a href="../../api/MagickCore/exception_8c.html" id="MagickFatalError">MagickFatalError</a></h2>
  254. <p>MagickFatalError() calls the fatal exception handler methods with an error reason.</p>
  255. <p>The format of the MagickError method is:</p>
  256. <pre class="bg-light text-dark mx-4"><samp>void MagickFatalError(const ExceptionType error,const char *reason,
  257. const char *description)
  258. </samp></pre>
  259. <p>A description of each parameter follows:</p>
  260. <dd>
  261. </dd>
  262. <dd> </dd>
  263. <dl class="dl-horizontal">
  264. <dt>exception</dt>
  265. <dd>Specifies the numeric error category. </dd>
  266. <dd> </dd>
  267. <dt>reason</dt>
  268. <dd>Specifies the reason to display before terminating the program. </dd>
  269. <dd> </dd>
  270. <dt>description</dt>
  271. <dd>Specifies any description to the reason. </dd>
  272. <dd> </dd>
  273. </dl>
  274. <h2><a href="../../api/MagickCore/exception_8c.html" id="MagickWarning">MagickWarning</a></h2>
  275. <p>MagickWarning() calls the warning handler methods with a warning reason.</p>
  276. <p>The format of the MagickWarning method is:</p>
  277. <pre class="bg-light text-dark mx-4"><samp>void MagickWarning(const ExceptionType warning,const char *reason,
  278. const char *description)
  279. </samp></pre>
  280. <p>A description of each parameter follows:</p>
  281. <dd>
  282. </dd>
  283. <dd> </dd>
  284. <dl class="dl-horizontal">
  285. <dt>warning</dt>
  286. <dd>the warning severity. </dd>
  287. <dd> </dd>
  288. <dt>reason</dt>
  289. <dd>Define the reason for the warning. </dd>
  290. <dd> </dd>
  291. <dt>description</dt>
  292. <dd>Describe the warning. </dd>
  293. <dd> </dd>
  294. </dl>
  295. <h2><a href="../../api/MagickCore/exception_8c.html" id="SetErrorHandler">SetErrorHandler</a></h2>
  296. <p>SetErrorHandler() sets the exception handler to the specified method and returns the previous exception handler.</p>
  297. <p>The format of the SetErrorHandler method is:</p>
  298. <pre class="bg-light text-dark mx-4"><samp>ErrorHandler SetErrorHandler(ErrorHandler handler)
  299. </samp></pre>
  300. <p>A description of each parameter follows:</p>
  301. <dd>
  302. </dd>
  303. <dd> </dd>
  304. <dl class="dl-horizontal">
  305. <dt>handler</dt>
  306. <dd>the method to handle errors. </dd>
  307. <dd> </dd>
  308. </dl>
  309. <h2><a href="../../api/MagickCore/exception_8c.html" id="SetFatalErrorHandler">SetFatalErrorHandler</a></h2>
  310. <p>SetFatalErrorHandler() sets the fatal exception handler to the specified method and returns the previous fatal exception handler.</p>
  311. <p>The format of the SetErrorHandler method is:</p>
  312. <pre class="bg-light text-dark mx-4"><samp>ErrorHandler SetErrorHandler(ErrorHandler handler)
  313. </samp></pre>
  314. <p>A description of each parameter follows:</p>
  315. <dd>
  316. </dd>
  317. <dd> </dd>
  318. <dl class="dl-horizontal">
  319. <dt>handler</dt>
  320. <dd>the method to handle errors. </dd>
  321. <dd> </dd>
  322. </dl>
  323. <h2><a href="../../api/MagickCore/exception_8c.html" id="SetWarningHandler">SetWarningHandler</a></h2>
  324. <p>SetWarningHandler() sets the warning handler to the specified method and returns the previous warning handler.</p>
  325. <p>The format of the SetWarningHandler method is:</p>
  326. <pre class="bg-light text-dark mx-4"><samp>ErrorHandler SetWarningHandler(ErrorHandler handler)
  327. </samp></pre>
  328. <p>A description of each parameter follows:</p>
  329. <dd>
  330. </dd>
  331. <dd> </dd>
  332. <dl class="dl-horizontal">
  333. <dt>handler</dt>
  334. <dd>the method to handle warnings. </dd>
  335. <dd> </dd>
  336. </dl>
  337. <h2><a href="../../api/MagickCore/exception_8c.html" id="ThrowException">ThrowException</a></h2>
  338. <p>ThrowException() throws an exception with the specified severity code, reason, and optional description.</p>
  339. <p>The format of the ThrowException method is:</p>
  340. <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType ThrowException(ExceptionInfo *exception,
  341. const ExceptionType severity,const char *reason,
  342. const char *description)
  343. </samp></pre>
  344. <p>A description of each parameter follows:</p>
  345. <dd>
  346. </dd>
  347. <dd> </dd>
  348. <dl class="dl-horizontal">
  349. <dt>exception</dt>
  350. <dd>the exception info. </dd>
  351. <dd> </dd>
  352. <dt>severity</dt>
  353. <dd>the severity of the exception. </dd>
  354. <dd> </dd>
  355. <dt>reason</dt>
  356. <dd>the reason for the exception. </dd>
  357. <dd> </dd>
  358. <dt>description</dt>
  359. <dd>the exception description. </dd>
  360. <dd> </dd>
  361. </dl>
  362. </div>
  363. </div>
  364. </main><!-- /.container -->
  365. <footer class="magick-footer">
  366. <div class="container-fluid">
  367. <a href="../../www/security-policy.html">Security</a> •
  368. <a href="../../www/news.html">News</a>
  369. <a href="exception.html#"><img class="d-inline" id="wand" alt="And Now a Touch of Magick" width="16" height="16" src="../../../images/wand.ico"/></a>
  370. <a href="../../www/links.html">Related</a> •
  371. <a href="../../www/sitemap.html">Sitemap</a>
  372. <br/>
  373. <a href="../../www/support.html">Sponsor</a> •
  374. <a href="../../www/cite.html">Cite</a> •
  375. <a href="http://pgp.mit.edu/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
  376. <a href="../../www/contact.html">Contact Us</a>
  377. <br/>
  378. <a href="https://github.com/imagemagick/imagemagick" target="_blank" rel="noopener" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 512 499.36" width="2%" height="2%" role="img" focusable="false"><title>GitHub</title><path fill="currentColor" fill-rule="evenodd" d="M256 0C114.64 0 0 114.61 0 256c0 113.09 73.34 209 175.08 242.9 12.8 2.35 17.47-5.56 17.47-12.34 0-6.08-.22-22.18-.35-43.54-71.2 15.49-86.2-34.34-86.2-34.34-11.64-29.57-28.42-37.45-28.42-37.45-23.27-15.84 1.73-15.55 1.73-15.55 25.69 1.81 39.21 26.38 39.21 26.38 22.84 39.12 59.92 27.82 74.5 21.27 2.33-16.54 8.94-27.82 16.25-34.22-56.84-6.43-116.6-28.43-116.6-126.49 0-27.95 10-50.8 26.35-68.69-2.63-6.48-11.42-32.5 2.51-67.75 0 0 21.49-6.88 70.4 26.24a242.65 242.65 0 0 1 128.18 0c48.87-33.13 70.33-26.24 70.33-26.24 14 35.25 5.18 61.27 2.55 67.75 16.41 17.9 26.31 40.75 26.31 68.69 0 98.35-59.85 120-116.88 126.32 9.19 7.9 17.38 23.53 17.38 47.41 0 34.22-.31 61.83-.31 70.23 0 6.85 4.61 14.81 17.6 12.31C438.72 464.97 512 369.08 512 256.02 512 114.62 397.37 0 256 0z"/></svg></a> •
  379. <a href="https://twitter.com/imagemagick" target="_blank" rel="noopener" aria-label="Twitter"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 300 300" width="2%" height="2%" role="img" focusable="false"><title>Twitter</title><path d="M178.57 127.15 290.27 0h-26.46l-97.03 110.38L89.34 0H0l117.13 166.93L0 300.25h26.46l102.4-116.59 81.8 116.59h89.34M36.01 19.54H76.66l187.13 262.13h-40.66"/></svg></a>
  380. <br/>
  381. <small>Copyright © 1999 ImageMagick Studio LLC</small>
  382. </div>
  383. </footer>
  384. <!-- Javascript assets -->
  385. <script src="../../assets/magick.js" ></script>
  386. </body>
  387. </html>