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