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