Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 7dca4891a9fbe6b373e20f28b991a94e8baa8d1d / . / www / api / module.html
blob: b71b4912564e77107c98bac83228c92e04aacfc2 [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">
cristy5350c7a2010-09-18 17:10:23 +0000[diff] [blame]130 <a title="Sponsor: alaTest.com" href="http://alatest.com">alaTest.com</a><!-- 20110801000300 -->
cristy73fd1cd2010-09-12 19:14:25 +0000[diff] [blame]131</div>
132<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]133 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
134</div>
135<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]136 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
137</div>
138<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]139 <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]140</div>
141<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]142 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000[diff] [blame]143</div>
144<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]145 <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]146</div>
147<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]148 <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]149</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]150</div>
151</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]152</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]153
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]154<div class="eastbar">
155 <script type="text/javascript">
156 <!--
157 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]158 google_ad_slot = "0574824969";
159 google_ad_width = 160;
160 google_ad_height = 600;
161 //-->
162 </script>
163 <script type="text/javascript"
164 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
165 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]166</div>
167
168<div class="main">
169
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]170<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]171
172<h2><a href="http://www.imagemagick.org/api/MagickCore/module
173_8c.html" target="source" name="AcquireModuleInfo">AcquireModuleInfo</a></h2>
174<div class="doc-section">
175
176<p>AcquireModuleInfo() allocates the ModuleInfo structure.</p></ol>
177
178<p>The format of the AcquireModuleInfo method is:</p>
179
180<pre class="code">
181 ModuleInfo *AcquireModuleInfo(const char *path,const char *tag)
182</pre>
183
184<p>A description of each parameter follows:</p></ol>
185
186<h5>path</h5>
187<ol><p>the path associated with the tag.</p></ol>
188
189<h5>tag</h5>
190<ol><p>a character string that represents the image format we are looking for.</p></ol>
191
192 </div>
193<h2><a href="http://www.imagemagick.org/api/MagickCore/module
194_8c.html" target="source" name="DestroyModuleList">DestroyModuleList</a></h2>
195<div class="doc-section">
196
197<p>DestroyModuleList() unregisters any previously loaded modules and exits the module loaded environment.</p></ol>
198
199<p>The format of the DestroyModuleList module is:</p>
200
201<pre class="text">
202 void DestroyModuleList(void)
203</pre>
204
205 </div>
206<h2><a href="http://www.imagemagick.org/api/MagickCore/module
207_8c.html" target="source" name="GetModuleInfo">GetModuleInfo</a></h2>
208<div class="doc-section">
209
210<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>
211
212<p>The format of the GetModuleInfo module is:</p>
213
214<pre class="text">
215 ModuleInfo *GetModuleInfo(const char *tag,ExceptionInfo *exception)
216</pre>
217
218<p>A description of each parameter follows:</p></ol>
219
220<h5>tag</h5>
221<ol><p>a character string that represents the image format we are looking for.</p></ol>
222
223<h5>exception</h5>
224<ol><p>return any errors or warnings in this structure.</p></ol>
225
226 </div>
227<h2><a href="http://www.imagemagick.org/api/MagickCore/module
228_8c.html" target="source" name="GetModuleInfoList">GetModuleInfoList</a></h2>
229<div class="doc-section">
230
231<p>GetModuleInfoList() returns any modules that match the specified pattern.</p></ol>
232
233<p>The format of the GetModuleInfoList function is:</p>
234
235<pre class="text">
236 const ModuleInfo **GetModuleInfoList(const char *pattern,
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]237 size_t *number_modules,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]238</pre>
239
240<p>A description of each parameter follows:</p></ol>
241
242<h5>pattern</h5>
243<ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
244
245<h5>number_modules</h5>
246<ol><p>This integer returns the number of modules in the list.</p></ol>
247
248<h5>exception</h5>
249<ol><p>return any errors or warnings in this structure.</p></ol>
250
251 </div>
252<h2><a href="http://www.imagemagick.org/api/MagickCore/module
253_8c.html" target="source" name="GetModuleList">GetModuleList</a></h2>
254<div class="doc-section">
255
256<p>GetModuleList() returns any image format modules that match the specified pattern.</p></ol>
257
258<p>The format of the GetModuleList function is:</p>
259
260<pre class="text">
cristyfbb4a972010-06-30 17:42:22 +0000[diff] [blame]261 char **GetModuleList(const char *pattern,const MagickModuleType type,
262 size_t *number_modules,ExceptionInfo *exception)
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]263</pre>
264
265<p>A description of each parameter follows:</p></ol>
266
267<h5>pattern</h5>
268<ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
269
cristyfbb4a972010-06-30 17:42:22 +0000[diff] [blame]270<h5>type</h5>
271<ol><p>choose from MagickImageCoderModule or MagickImageFilterModule.</p></ol>
272
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]273<h5>number_modules</h5>
274<ol><p>This integer returns the number of modules in the list.</p></ol>
275
276<h5>exception</h5>
277<ol><p>return any errors or warnings in this structure.</p></ol>
278
279 </div>
280<h2><a href="http://www.imagemagick.org/api/MagickCore/module
281_8c.html" target="source" name="GetMagickModulePath">GetMagickModulePath</a></h2>
282<div class="doc-section">
283
284<p>GetMagickModulePath() finds a module with the specified module type and filename.</p></ol>
285
286<p>The format of the GetMagickModulePath module is:</p>
287
288<pre class="text">
289 MagickBooleanType GetMagickModulePath(const char *filename,
290 MagickModuleType module_type,char *path,ExceptionInfo *exception)
291</pre>
292
293<p>A description of each parameter follows:</p></ol>
294
295<h5>filename</h5>
296<ol><p>the module file name.</p></ol>
297
298<h5>module_type</h5>
299<ol><p>the module type: MagickImageCoderModule or MagickImageFilterModule.</p></ol>
300
301<h5>path</h5>
302<ol><p>the path associated with the filename.</p></ol>
303
304<h5>exception</h5>
305<ol><p>return any errors or warnings in this structure.</p></ol>
306
307 </div>
308<h2><a href="http://www.imagemagick.org/api/MagickCore/module
cristy83543962009-10-16 19:04:28 +0000[diff] [blame]309_8c.html" target="source" name="InitializeModuleList">InitializeModuleList</a></h2>
310<div class="doc-section">
311
312<p>InitializeModuleList() initializes the module loader.</p></ol>
313
314<p>The format of the InitializeModuleList() method is:</p>
315
316<pre class="code">
317 InitializeModuleList(Exceptioninfo *exception)
318</pre>
319
320<p>A description of each parameter follows.</p></ol>
321
322<h5>exception</h5>
323<ol><p>return any errors or warnings in this structure.</p></ol>
324
325 </div>
326<h2><a href="http://www.imagemagick.org/api/MagickCore/module
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]327_8c.html" target="source" name="InvokeDynamicImageFilter">InvokeDynamicImageFilter</a></h2>
328<div class="doc-section">
329
330<p>InvokeDynamicImageFilter() invokes a dynamic image filter.</p></ol>
331
332<p>The format of the InvokeDynamicImageFilter module is:</p>
333
334<pre class="text">
335 MagickBooleanType InvokeDynamicImageFilter(const char *tag,Image **image,
336 const int argc,const char **argv,ExceptionInfo *exception)
337</pre>
338
339<p>A description of each parameter follows:</p></ol>
340
341<h5>tag</h5>
342<ol><p>a character string that represents the name of the particular module.</p></ol>
343
344<h5>image</h5>
345<ol><p>the image.</p></ol>
346
347<h5>argc</h5>
348<ol><p>a pointer to an integer describing the number of elements in the argument vector.</p></ol>
349
350<h5>argv</h5>
351<ol><p>a pointer to a text array containing the command line arguments.</p></ol>
352
353<h5>exception</h5>
354<ol><p>return any errors or warnings in this structure.</p></ol>
355
356 </div>
357<h2><a href="http://www.imagemagick.org/api/MagickCore/module
358_8c.html" target="source" name="ListModuleInfo">ListModuleInfo</a></h2>
359<div class="doc-section">
360
361<p>ListModuleInfo() lists the module info to a file.</p></ol>
362
363<p>The format of the ListModuleInfo module is:</p>
364
365<pre class="text">
366 MagickBooleanType ListModuleInfo(FILE *file,ExceptionInfo *exception)
367</pre>
368
369<p>A description of each parameter follows.</p></ol>
370
371<h5>file</h5>
372<ol><p>An pointer to a FILE.</p></ol>
373
374<h5>exception</h5>
375<ol><p>return any errors or warnings in this structure.</p></ol>
376
377 </div>
378<h2><a href="http://www.imagemagick.org/api/MagickCore/module
379_8c.html" target="source" name="OpenModule">OpenModule</a></h2>
380<div class="doc-section">
381
382<p>OpenModule() loads a module, and invokes its registration module. It returns MagickTrue on success, and MagickFalse if there is an error.</p></ol>
383
384<p>The format of the OpenModule module is:</p>
385
386<pre class="text">
387 MagickBooleanType OpenModule(const char *module,ExceptionInfo *exception)
388</pre>
389
390<p>A description of each parameter follows:</p></ol>
391
392<h5>module</h5>
393<ol><p>a character string that indicates the module to load.</p></ol>
394
395<h5>exception</h5>
396<ol><p>return any errors or warnings in this structure.</p></ol>
397
398 </div>
399<h2><a href="http://www.imagemagick.org/api/MagickCore/module
400_8c.html" target="source" name="OpenModules">OpenModules</a></h2>
401<div class="doc-section">
402
403<p>OpenModules() loads all available modules.</p></ol>
404
405<p>The format of the OpenModules module is:</p>
406
407<pre class="text">
408 MagickBooleanType OpenModules(ExceptionInfo *exception)
409</pre>
410
411<p>A description of each parameter follows:</p></ol>
412
413<h5>exception</h5>
414<ol><p>return any errors or warnings in this structure.</p></ol>
415
416 </div>
417<h2><a href="http://www.imagemagick.org/api/MagickCore/module
418_8c.html" target="source" name="RegisterModule">RegisterModule</a></h2>
419<div class="doc-section">
420
421<p>RegisterModule() adds an entry to the module list. It returns a pointer to the registered entry on success.</p></ol>
422
423<p>The format of the RegisterModule module is:</p>
424
425<pre class="text">
426 ModuleInfo *RegisterModule(const ModuleInfo *module_info,
427 ExceptionInfo *exception)
428</pre>
429
430<p>A description of each parameter follows:</p></ol>
431
432<h5>info</h5>
433<ol><p>a pointer to the registered entry is returned.</p></ol>
434
435<h5>module_info</h5>
436<ol><p>a pointer to the ModuleInfo structure to register.</p></ol>
437
438<h5>exception</h5>
439<ol><p>return any errors or warnings in this structure.</p></ol>
440
441 </div>
442<h2><a href="http://www.imagemagick.org/api/MagickCore/module
443_8c.html" target="source" name="TagToCoderModuleName">TagToCoderModuleName</a></h2>
444<div class="doc-section">
445
446<p>TagToCoderModuleName() munges a module tag and obtains the filename of the corresponding module.</p></ol>
447
448<p>The format of the TagToCoderModuleName module is:</p>
449
450<pre class="text">
451 char *TagToCoderModuleName(const char *tag,char *name)
452</pre>
453
454<p>A description of each parameter follows:</p></ol>
455
456<h5>tag</h5>
457<ol><p>a character string representing the module tag.</p></ol>
458
459<h5>name</h5>
460<ol><p>return the module name here.</p></ol>
461
462 </div>
463<h2><a href="http://www.imagemagick.org/api/MagickCore/module
464_8c.html" target="source" name="TagToFilterModuleName">TagToFilterModuleName</a></h2>
465<div class="doc-section">
466
467<p>TagToFilterModuleName() munges a module tag and returns the filename of the corresponding filter module.</p></ol>
468
469<p>The format of the TagToFilterModuleName module is:</p>
470
471<pre class="text">
472 void TagToFilterModuleName(const char *tag,char name)
473</pre>
474
475<p>A description of each parameter follows:</p></ol>
476
477<h5>tag</h5>
478<ol><p>a character string representing the module tag.</p></ol>
479
480<h5>name</h5>
481<ol><p>return the filter name here.</p></ol>
482
483 </div>
484<h2><a href="http://www.imagemagick.org/api/MagickCore/module
485_8c.html" target="source" name="TagToModuleName">TagToModuleName</a></h2>
486<div class="doc-section">
487
488<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>
489
490<p>The format of the TagToModuleName module is:</p>
491
492<pre class="text">
493 TagToModuleName(const char *tag,const char *format,char *module)
494</pre>
495
496<p>A description of each parameter follows:</p></ol>
497
498<h5>tag</h5>
499<ol><p>the module tag.</p></ol>
500
501<h5>format</h5>
502<ol><p>a sprintf-compatible format string containing s where the upper-case tag name is to be inserted.</p></ol>
503
504<h5>module</h5>
505<ol><p>pointer to a destination buffer for the formatted result.</p></ol>
506
507 </div>
508<h2><a href="http://www.imagemagick.org/api/MagickCore/module
509_8c.html" target="source" name="UnregisterModule">UnregisterModule</a></h2>
510<div class="doc-section">
511
512<p>UnregisterModule() unloads a module, and invokes its de-registration module. Returns MagickTrue on success, and MagickFalse if there is an error.</p></ol>
513
514<p>The format of the UnregisterModule module is:</p>
515
516<pre class="text">
517 MagickBooleanType UnregisterModule(const ModuleInfo *module_info,
518 ExceptionInfo *exception)
519</pre>
520
521<p>A description of each parameter follows:</p></ol>
522
523<h5>module_info</h5>
524<ol><p>the module info.</p></ol>
525
526<h5>exception</h5>
527<ol><p>return any errors or warnings in this structure.</p></ol>
528
529 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]530
531</div>
532
533<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]534 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]535 <span id="linkbar-center">
536 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]537 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]538 </span>
539 <span id="linkbar-east">&nbsp;</span>
540 </div>
541 <div class="footer">
542 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
543 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
544 </div>
545 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]546 <script type="text/javascript">
547 var _gaq = _gaq || [];
548 _gaq.push(['_setAccount', 'UA-17690367-1']);
549 _gaq.push(['_trackPageview']);
550
551 (function() {
552 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
553 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
554 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
555 })();
556 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]557</body>
558</html>