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