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