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