Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 0c5f7e9f19fa97e227640344e293c00bd7240c8c / . / www / api / module.html
blob: fdaa59bb2df0d2d3b945be9d263b0eda9c617016 [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame]3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
7 <title>ImageMagick: MagickCore, C API for ImageMagick: Loadable Modules</title/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]8 <meta http-equiv="Content-Language" content="en-US"/>
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
10 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]11 <meta name="Application-name" content="ImageMagick"/>
12 <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."/>
13 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]14 <meta name="Generator" content="PHP"/>
15 <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, loadable, modules, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]16 <meta name="Rating" content="GENERAL"/>
17 <meta name="Robots" content="INDEX, FOLLOW"/>
18 <meta name="Generator" content="ImageMagick Studio LLC"/>
19 <meta name="Author" content="ImageMagick Studio LLC"/>
20 <meta name="Revisit-after" content="2 DAYS"/>
21 <meta name="Resource-type" content="document"/>
cristy16af1cb2009-12-11 21:38:29 +0000[diff] [blame]22 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]23 <meta name="Distribution" content="Global"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]24 <link rel="icon" href="../../images/wand.png" sizes="32x32"/>
25 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
26 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
27 <style type="text/css" media="all">
28 @import url("../../www/magick.css");
29 </style>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]30</head>
31
32<body id="www-imagemagick-org">
33<div class="titlebar">
34<a href="../../index.html">
35 <img src="../../images/script.png" alt="[ImageMagick]"
36 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
37<a href="http://www.networkredux.com">
38 <img src="../../images/networkredux.png" alt="[sponsor]"
39 style="margin: 45px auto; border: 0px; float: left;" /></a>
40<a href="http://www.imagemagick.org/discourse-server/">
41 <img src="../../images/logo.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43<a href="../../index.html">
44 <img src="../../images/sprite.jpg" alt=""
45 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
46</div>
47
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]48<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]49
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]50<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]51 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]52</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]53<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]54<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]55 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
56</div>
57<div class="sub">
58 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
59</div>
60<div class="sub">
61 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
62</div>
63<div class="sub">
64 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
65</div>
66<div class="sep"></div>
67<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]68 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]69</div>
70<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]71 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]72</div>
73<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]74 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]75</div>
76<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]77 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]78</div>
79<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]80 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]81</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]83 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]84</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]86 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]87</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]89 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]90</div>
91<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]92 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]93</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]94<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]95<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]96 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]97</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]99 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]102 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103 </div>
104<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]105 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]106</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]107<div class="menu">
108 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
109</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]110<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]111 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]112</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]113<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]114<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]115 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]116</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]117<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]118<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]119 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
121<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]122 <a title="Site Map: Links"href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]123</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]124<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]125<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]126 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]127
128<div class="sponsbox">
129<div class="sponsor">
cristy7f3f7322010-11-06 18:47:36 +0000[diff] [blame]130 <a title="Sponsor: Webdesign" href="http://www.renehornig.com/">Webdesign</a><!-- 20111001000240 -->
cristy7d52cd62010-10-01 17:26:59 +0000[diff] [blame]131</div>
132<div class="sponsor">
133 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +0000[diff] [blame]134</div>
135<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]136 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
137</div>
138<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]139 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
140</div>
141<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]142 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy320dd6e2010-04-16 20:11:40 +0000[diff] [blame]143</div>
144<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]145 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000[diff] [blame]146</div>
147<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]148 <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]149</div>
150<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]151 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]152</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]153</div>
154</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]155</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]156
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]157<div class="eastbar">
158 <script type="text/javascript">
159 <!--
160 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]161 google_ad_slot = "0574824969";
162 google_ad_width = 160;
163 google_ad_height = 600;
164 //-->
165 </script>
166 <script type="text/javascript"
167 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
168 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]169</div>
170
171<div class="main">
172
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]173<p class="navigation-index">[<a href="#AcquireModuleInfo">AcquireModuleInfo</a> &bull; <a href="#DestroyModuleList">DestroyModuleList</a> &bull; <a href="#GetModuleInfo">GetModuleInfo</a> &bull; <a href="#GetModuleInfoList">GetModuleInfoList</a> &bull; <a href="#GetModuleList">GetModuleList</a> &bull; <a href="#GetMagickModulePath">GetMagickModulePath</a> &bull; <a href="#InitializeModuleList">InitializeModuleList</a> &bull; <a href="#InvokeDynamicImageFilter">InvokeDynamicImageFilter</a> &bull; <a href="#ListModuleInfo">ListModuleInfo</a> &bull; <a href="#OpenModule">OpenModule</a> &bull; <a href="#OpenModules">OpenModules</a> &bull; <a href="#RegisterModule">RegisterModule</a> &bull; <a href="#TagToCoderModuleName">TagToCoderModuleName</a> &bull; <a href="#TagToFilterModuleName">TagToFilterModuleName</a> &bull; <a href="#TagToModuleName">TagToModuleName</a> &bull; <a href="#UnregisterModule">UnregisterModule</a>]</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]174
175<h2><a href="http://www.imagemagick.org/api/MagickCore/module
176_8c.html" target="source" name="AcquireModuleInfo">AcquireModuleInfo</a></h2>
177<div class="doc-section">
178
179<p>AcquireModuleInfo() allocates the ModuleInfo structure.</p></ol>
180
181<p>The format of the AcquireModuleInfo method is:</p>
182
183<pre class="code">
184 ModuleInfo *AcquireModuleInfo(const char *path,const char *tag)
185</pre>
186
187<p>A description of each parameter follows:</p></ol>
188
189<h5>path</h5>
190<ol><p>the path associated with the tag.</p></ol>
191
192<h5>tag</h5>
193<ol><p>a character string that represents the image format we are looking for.</p></ol>
194
195 </div>
196<h2><a href="http://www.imagemagick.org/api/MagickCore/module
197_8c.html" target="source" name="DestroyModuleList">DestroyModuleList</a></h2>
198<div class="doc-section">
199
200<p>DestroyModuleList() unregisters any previously loaded modules and exits the module loaded environment.</p></ol>
201
202<p>The format of the DestroyModuleList module is:</p>
203
204<pre class="text">
205 void DestroyModuleList(void)
206</pre>
207
208 </div>
209<h2><a href="http://www.imagemagick.org/api/MagickCore/module
210_8c.html" target="source" name="GetModuleInfo">GetModuleInfo</a></h2>
211<div class="doc-section">
212
213<p>GetModuleInfo() returns a pointer to a ModuleInfo structure that matches the specified tag. If tag is NULL, the head of the module list is returned. If no modules are loaded, or the requested module is not found, NULL is returned.</p></ol>
214
215<p>The format of the GetModuleInfo module is:</p>
216
217<pre class="text">
218 ModuleInfo *GetModuleInfo(const char *tag,ExceptionInfo *exception)
219</pre>
220
221<p>A description of each parameter follows:</p></ol>
222
223<h5>tag</h5>
224<ol><p>a character string that represents the image format we are looking for.</p></ol>
225
226<h5>exception</h5>
227<ol><p>return any errors or warnings in this structure.</p></ol>
228
229 </div>
230<h2><a href="http://www.imagemagick.org/api/MagickCore/module
231_8c.html" target="source" name="GetModuleInfoList">GetModuleInfoList</a></h2>
232<div class="doc-section">
233
234<p>GetModuleInfoList() returns any modules that match the specified pattern.</p></ol>
235
236<p>The format of the GetModuleInfoList function is:</p>
237
238<pre class="text">
239 const ModuleInfo **GetModuleInfoList(const char *pattern,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]240 size_t *number_modules,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]241</pre>
242
243<p>A description of each parameter follows:</p></ol>
244
245<h5>pattern</h5>
246<ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
247
248<h5>number_modules</h5>
249<ol><p>This integer returns the number of modules in the list.</p></ol>
250
251<h5>exception</h5>
252<ol><p>return any errors or warnings in this structure.</p></ol>
253
254 </div>
255<h2><a href="http://www.imagemagick.org/api/MagickCore/module
256_8c.html" target="source" name="GetModuleList">GetModuleList</a></h2>
257<div class="doc-section">
258
259<p>GetModuleList() returns any image format modules that match the specified pattern.</p></ol>
260
261<p>The format of the GetModuleList function is:</p>
262
263<pre class="text">
cristyfbb4a972010-06-30 17:42:22 +0000[diff] [blame]264 char **GetModuleList(const char *pattern,const MagickModuleType type,
265 size_t *number_modules,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]266</pre>
267
268<p>A description of each parameter follows:</p></ol>
269
270<h5>pattern</h5>
271<ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
272
cristyfbb4a972010-06-30 17:42:22 +0000[diff] [blame]273<h5>type</h5>
274<ol><p>choose from MagickImageCoderModule or MagickImageFilterModule.</p></ol>
275
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]276<h5>number_modules</h5>
277<ol><p>This integer returns the number of modules in the list.</p></ol>
278
279<h5>exception</h5>
280<ol><p>return any errors or warnings in this structure.</p></ol>
281
282 </div>
283<h2><a href="http://www.imagemagick.org/api/MagickCore/module
284_8c.html" target="source" name="GetMagickModulePath">GetMagickModulePath</a></h2>
285<div class="doc-section">
286
287<p>GetMagickModulePath() finds a module with the specified module type and filename.</p></ol>
288
289<p>The format of the GetMagickModulePath module is:</p>
290
291<pre class="text">
292 MagickBooleanType GetMagickModulePath(const char *filename,
293 MagickModuleType module_type,char *path,ExceptionInfo *exception)
294</pre>
295
296<p>A description of each parameter follows:</p></ol>
297
298<h5>filename</h5>
299<ol><p>the module file name.</p></ol>
300
301<h5>module_type</h5>
302<ol><p>the module type: MagickImageCoderModule or MagickImageFilterModule.</p></ol>
303
304<h5>path</h5>
305<ol><p>the path associated with the filename.</p></ol>
306
307<h5>exception</h5>
308<ol><p>return any errors or warnings in this structure.</p></ol>
309
310 </div>
311<h2><a href="http://www.imagemagick.org/api/MagickCore/module
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]312_8c.html" target="source" name="InitializeModuleList">InitializeModuleList</a></h2>
313<div class="doc-section">
314
315<p>InitializeModuleList() initializes the module loader.</p></ol>
316
317<p>The format of the InitializeModuleList() method is:</p>
318
319<pre class="code">
320 InitializeModuleList(Exceptioninfo *exception)
321</pre>
322
323<p>A description of each parameter follows.</p></ol>
324
325<h5>exception</h5>
326<ol><p>return any errors or warnings in this structure.</p></ol>
327
328 </div>
329<h2><a href="http://www.imagemagick.org/api/MagickCore/module
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]330_8c.html" target="source" name="InvokeDynamicImageFilter">InvokeDynamicImageFilter</a></h2>
331<div class="doc-section">
332
333<p>InvokeDynamicImageFilter() invokes a dynamic image filter.</p></ol>
334
335<p>The format of the InvokeDynamicImageFilter module is:</p>
336
337<pre class="text">
338 MagickBooleanType InvokeDynamicImageFilter(const char *tag,Image **image,
339 const int argc,const char **argv,ExceptionInfo *exception)
340</pre>
341
342<p>A description of each parameter follows:</p></ol>
343
344<h5>tag</h5>
345<ol><p>a character string that represents the name of the particular module.</p></ol>
346
347<h5>image</h5>
348<ol><p>the image.</p></ol>
349
350<h5>argc</h5>
351<ol><p>a pointer to an integer describing the number of elements in the argument vector.</p></ol>
352
353<h5>argv</h5>
354<ol><p>a pointer to a text array containing the command line arguments.</p></ol>
355
356<h5>exception</h5>
357<ol><p>return any errors or warnings in this structure.</p></ol>
358
359 </div>
360<h2><a href="http://www.imagemagick.org/api/MagickCore/module
361_8c.html" target="source" name="ListModuleInfo">ListModuleInfo</a></h2>
362<div class="doc-section">
363
364<p>ListModuleInfo() lists the module info to a file.</p></ol>
365
366<p>The format of the ListModuleInfo module is:</p>
367
368<pre class="text">
369 MagickBooleanType ListModuleInfo(FILE *file,ExceptionInfo *exception)
370</pre>
371
372<p>A description of each parameter follows.</p></ol>
373
374<h5>file</h5>
375<ol><p>An pointer to a FILE.</p></ol>
376
377<h5>exception</h5>
378<ol><p>return any errors or warnings in this structure.</p></ol>
379
380 </div>
381<h2><a href="http://www.imagemagick.org/api/MagickCore/module
382_8c.html" target="source" name="OpenModule">OpenModule</a></h2>
383<div class="doc-section">
384
385<p>OpenModule() loads a module, and invokes its registration module. It returns MagickTrue on success, and MagickFalse if there is an error.</p></ol>
386
387<p>The format of the OpenModule module is:</p>
388
389<pre class="text">
390 MagickBooleanType OpenModule(const char *module,ExceptionInfo *exception)
391</pre>
392
393<p>A description of each parameter follows:</p></ol>
394
395<h5>module</h5>
396<ol><p>a character string that indicates the module to load.</p></ol>
397
398<h5>exception</h5>
399<ol><p>return any errors or warnings in this structure.</p></ol>
400
401 </div>
402<h2><a href="http://www.imagemagick.org/api/MagickCore/module
403_8c.html" target="source" name="OpenModules">OpenModules</a></h2>
404<div class="doc-section">
405
406<p>OpenModules() loads all available modules.</p></ol>
407
408<p>The format of the OpenModules module is:</p>
409
410<pre class="text">
411 MagickBooleanType OpenModules(ExceptionInfo *exception)
412</pre>
413
414<p>A description of each parameter follows:</p></ol>
415
416<h5>exception</h5>
417<ol><p>return any errors or warnings in this structure.</p></ol>
418
419 </div>
420<h2><a href="http://www.imagemagick.org/api/MagickCore/module
421_8c.html" target="source" name="RegisterModule">RegisterModule</a></h2>
422<div class="doc-section">
423
424<p>RegisterModule() adds an entry to the module list. It returns a pointer to the registered entry on success.</p></ol>
425
426<p>The format of the RegisterModule module is:</p>
427
428<pre class="text">
429 ModuleInfo *RegisterModule(const ModuleInfo *module_info,
430 ExceptionInfo *exception)
431</pre>
432
433<p>A description of each parameter follows:</p></ol>
434
435<h5>info</h5>
436<ol><p>a pointer to the registered entry is returned.</p></ol>
437
438<h5>module_info</h5>
439<ol><p>a pointer to the ModuleInfo structure to register.</p></ol>
440
441<h5>exception</h5>
442<ol><p>return any errors or warnings in this structure.</p></ol>
443
444 </div>
445<h2><a href="http://www.imagemagick.org/api/MagickCore/module
446_8c.html" target="source" name="TagToCoderModuleName">TagToCoderModuleName</a></h2>
447<div class="doc-section">
448
449<p>TagToCoderModuleName() munges a module tag and obtains the filename of the corresponding module.</p></ol>
450
451<p>The format of the TagToCoderModuleName module is:</p>
452
453<pre class="text">
454 char *TagToCoderModuleName(const char *tag,char *name)
455</pre>
456
457<p>A description of each parameter follows:</p></ol>
458
459<h5>tag</h5>
460<ol><p>a character string representing the module tag.</p></ol>
461
462<h5>name</h5>
463<ol><p>return the module name here.</p></ol>
464
465 </div>
466<h2><a href="http://www.imagemagick.org/api/MagickCore/module
467_8c.html" target="source" name="TagToFilterModuleName">TagToFilterModuleName</a></h2>
468<div class="doc-section">
469
470<p>TagToFilterModuleName() munges a module tag and returns the filename of the corresponding filter module.</p></ol>
471
472<p>The format of the TagToFilterModuleName module is:</p>
473
474<pre class="text">
475 void TagToFilterModuleName(const char *tag,char name)
476</pre>
477
478<p>A description of each parameter follows:</p></ol>
479
480<h5>tag</h5>
481<ol><p>a character string representing the module tag.</p></ol>
482
483<h5>name</h5>
484<ol><p>return the filter name here.</p></ol>
485
486 </div>
487<h2><a href="http://www.imagemagick.org/api/MagickCore/module
488_8c.html" target="source" name="TagToModuleName">TagToModuleName</a></h2>
489<div class="doc-section">
490
491<p>TagToModuleName() munges the module tag name and returns an upper-case tag name as the input string, and a user-provided format.</p></ol>
492
493<p>The format of the TagToModuleName module is:</p>
494
495<pre class="text">
496 TagToModuleName(const char *tag,const char *format,char *module)
497</pre>
498
499<p>A description of each parameter follows:</p></ol>
500
501<h5>tag</h5>
502<ol><p>the module tag.</p></ol>
503
504<h5>format</h5>
505<ol><p>a sprintf-compatible format string containing s where the upper-case tag name is to be inserted.</p></ol>
506
507<h5>module</h5>
508<ol><p>pointer to a destination buffer for the formatted result.</p></ol>
509
510 </div>
511<h2><a href="http://www.imagemagick.org/api/MagickCore/module
512_8c.html" target="source" name="UnregisterModule">UnregisterModule</a></h2>
513<div class="doc-section">
514
515<p>UnregisterModule() unloads a module, and invokes its de-registration module. Returns MagickTrue on success, and MagickFalse if there is an error.</p></ol>
516
517<p>The format of the UnregisterModule module is:</p>
518
519<pre class="text">
520 MagickBooleanType UnregisterModule(const ModuleInfo *module_info,
521 ExceptionInfo *exception)
522</pre>
523
524<p>A description of each parameter follows:</p></ol>
525
526<h5>module_info</h5>
527<ol><p>the module info.</p></ol>
528
529<h5>exception</h5>
530<ol><p>return any errors or warnings in this structure.</p></ol>
531
532 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]533
534</div>
535
536<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]537 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]538 <span id="linkbar-center">
539 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]540 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]541 </span>
542 <span id="linkbar-east">&nbsp;</span>
543 </div>
544 <div class="footer">
545 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
546 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
547 </div>
548 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]549 <script type="text/javascript">
550 var _gaq = _gaq || [];
551 _gaq.push(['_setAccount', 'UA-17690367-1']);
552 _gaq.push(['_trackPageview']);
553
554 (function() {
555 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
556 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
557 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
558 })();
559 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]560</body>
561</html>