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