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