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