1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
\r
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
\r
3 <html version="-//W3C//DTD XHTML 1.1//EN"
\r
4 xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
\r
5 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
\r
6 xsi:schemaLocation="http://www.w3.org/1999/xhtml
\r
7 http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
\r
9 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
\r
10 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
\r
11 <title>ImageMagick: MagickCore, C API for ImageMagick: Loadable Modules</title>
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"/>
15 <meta name="Application-name" content="ImageMagick"/>
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."/>
17 <meta name="Application-url" content="http://www.imagemagick.org"/>
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"/>
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"/>
26 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
27 <meta name="Distribution" content="Global"/>
28 <link rel="icon" href="../../images/wand.png"/>
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"/>
\r
31 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
\r
32 <style type="text/css" media="all">
\r
33 @import url("../../www/magick.css");
\r
35 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
\r
36 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
\r
37 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
\r
38 <script type="text/javascript">
\r
39 $(document).ready(function() {
\r
40 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
\r
41 'transitionIn' : 'elastic',
\r
42 'transitionOut' : 'elastic',
\r
43 'overlayShow' : false,
\r
50 <body id="www-imagemagick-org">
\r
51 <div class="titlebar">
\r
52 <div style="margin: 17px auto; float: left;">
\r
53 <script type="text/javascript">
\r
55 google_ad_client = "pub-3129977114552745";
\r
56 google_ad_slot = "5439289906";
\r
57 google_ad_width = 728;
\r
58 google_ad_height = 90;
\r
61 <script type="text/javascript"
\r
62 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
\r
65 <a href="http://www.imagemagick.org/discourse-server/">
\r
66 <img src="../../images/logo.jpg"
\r
67 alt="ImageMagick Logo"
\r
68 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
\r
69 <a href="../../index.html">
\r
70 <img src="../../images/sprite.jpg"
\r
71 alt="ImageMagick Sprite"
\r
72 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
75 <div class="westbar">
\r
78 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
80 <div class="sep"></div>
\r
82 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
85 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
88 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
91 <a title="Binary Release: iPhone" href="../../www/binary-releases.html#iPhone">iPhone</a>
94 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
96 <div class="sep"></div>
\r
98 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
101 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
104 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
107 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
110 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
113 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
116 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
119 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
122 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
124 <div class="sep"></div>
\r
126 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
129 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
132 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
135 <a title="Resources" href="../../www/resources.html">Resources</a>
138 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
141 <a title="Download" href="../../www/download.html">Download</a>
143 <div class="sep"></div>
\r
145 <a title="Search" href="../../www/search.html">Search</a>
147 <div class="sep"></div>
\r
149 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
152 <a title="Site Map: Links" href="../../www/links.html">Links</a>
154 <div class="sep"></div>
\r
156 <a rel="follow" title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
158 <a href="http://www.networkredux.com">
159 <img src="../../images/networkredux.png" alt="[sponsor]"
160 style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
161 <div class="sponsbox">
162 <div class="sponsor">
163 <a rel="follow" title="Sponsor: Web Hosting Break" href="http://www.webhostingbreak.com">Web Hosting Break</a><!-- 201109010090 ian@ian-m... -->
165 <div class="sponsor">
166 <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
168 <div class="sponsor">
169 <a rel="follow" title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201110010090 alexanian media -->
171 <div class="sponsor">
172 <a rel="follow" title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
174 <div class="sponsor">
175 <a rel="follow" title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
177 <div class="sponsor">
178 <a rel="follow" title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
180 <div class="sponsor">
181 <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingmasters.com">Web Hosting Reviews</a><!-- 201107011500 affliatelabel -->
183 <div class="sponsor">
184 <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
186 <div class="sponsor">
187 <a rel="follow" title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
189 <div class="sponsor">
190 <a rel="follow" title="Sponsor: alaTest.com" href="http://alatest.com">alaTest.com</a><!-- 20110801000300 -->
196 <div class="eastbar">
\r
202 <h1>Module module Methods</h1>
203 <p class="navigation-index">[<a href="#AcquireModuleInfo">AcquireModuleInfo</a> • <a href="#DestroyModuleList">DestroyModuleList</a> • <a href="#GetModuleInfo">GetModuleInfo</a> • <a href="#GetModuleInfoList">GetModuleInfoList</a> • <a href="#GetModuleList">GetModuleList</a> • <a href="#GetMagickModulePath">GetMagickModulePath</a> • <a href="#InitializeModuleList">InitializeModuleList</a> • <a href="#InvokeDynamicImageFilter">InvokeDynamicImageFilter</a> • <a href="#ListModuleInfo">ListModuleInfo</a> • <a href="#OpenModule">OpenModule</a> • <a href="#OpenModules">OpenModules</a> • <a href="#RegisterModule">RegisterModule</a> • <a href="#TagToCoderModuleName">TagToCoderModuleName</a> • <a href="#TagToFilterModuleName">TagToFilterModuleName</a> • <a href="#TagToModuleName">TagToModuleName</a> • <a href="#UnregisterModule">UnregisterModule</a>]</p>
205 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="AcquireModuleInfo">AcquireModuleInfo</a></h2>
206 <div class="doc-section">
208 <p>AcquireModuleInfo() allocates the ModuleInfo structure.</p>
210 <p>The format of the AcquireModuleInfo method is:</p>
213 ModuleInfo *AcquireModuleInfo(const char *path,const char *tag)
216 <p>A description of each parameter follows:</p>
219 <p>the path associated with the tag.</p>
222 <p>a character string that represents the image format we are looking for.</p>
225 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="DestroyModuleList">DestroyModuleList</a></h2>
226 <div class="doc-section">
228 <p>DestroyModuleList() unregisters any previously loaded modules and exits the module loaded environment.</p>
230 <p>The format of the DestroyModuleList module is:</p>
233 void DestroyModuleList(void)
237 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="GetModuleInfo">GetModuleInfo</a></h2>
238 <div class="doc-section">
240 <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>
242 <p>The format of the GetModuleInfo module is:</p>
245 ModuleInfo *GetModuleInfo(const char *tag,ExceptionInfo *exception)
248 <p>A description of each parameter follows:</p>
251 <p>a character string that represents the image format we are looking for.</p>
254 <p>return any errors or warnings in this structure.</p>
257 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="GetModuleInfoList">GetModuleInfoList</a></h2>
258 <div class="doc-section">
260 <p>GetModuleInfoList() returns any modules that match the specified pattern.</p>
262 <p>The format of the GetModuleInfoList function is:</p>
265 const ModuleInfo **GetModuleInfoList(const char *pattern,
266 size_t *number_modules,ExceptionInfo *exception)
269 <p>A description of each parameter follows:</p>
272 <p>Specifies a pointer to a text string containing a pattern.</p>
274 <h5>number_modules</h5>
275 <p>This integer returns the number of modules in the list.</p>
278 <p>return any errors or warnings in this structure.</p>
281 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="GetModuleList">GetModuleList</a></h2>
282 <div class="doc-section">
284 <p>GetModuleList() returns any image format modules that match the specified pattern.</p>
286 <p>The format of the GetModuleList function is:</p>
289 char **GetModuleList(const char *pattern,const MagickModuleType type,
290 size_t *number_modules,ExceptionInfo *exception)
293 <p>A description of each parameter follows:</p>
296 <p>Specifies a pointer to a text string containing a pattern.</p>
299 <p>choose from MagickImageCoderModule or MagickImageFilterModule.</p>
301 <h5>number_modules</h5>
302 <p>This integer returns the number of modules in the list.</p>
305 <p>return any errors or warnings in this structure.</p>
308 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="GetMagickModulePath">GetMagickModulePath</a></h2>
309 <div class="doc-section">
311 <p>GetMagickModulePath() finds a module with the specified module type and filename.</p>
313 <p>The format of the GetMagickModulePath module is:</p>
316 MagickBooleanType GetMagickModulePath(const char *filename,
317 MagickModuleType module_type,char *path,ExceptionInfo *exception)
320 <p>A description of each parameter follows:</p>
323 <p>the module file name.</p>
326 <p>the module type: MagickImageCoderModule or MagickImageFilterModule.</p>
329 <p>the path associated with the filename.</p>
332 <p>return any errors or warnings in this structure.</p>
335 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="InitializeModuleList">InitializeModuleList</a></h2>
336 <div class="doc-section">
338 <p>InitializeModuleList() initializes the module loader.</p>
340 <p>The format of the InitializeModuleList() method is:</p>
343 InitializeModuleList(Exceptioninfo *exception)
346 <p>A description of each parameter follows.</p>
349 <p>return any errors or warnings in this structure.</p>
352 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="InvokeDynamicImageFilter">InvokeDynamicImageFilter</a></h2>
353 <div class="doc-section">
355 <p>InvokeDynamicImageFilter() invokes a dynamic image filter.</p>
357 <p>The format of the InvokeDynamicImageFilter module is:</p>
360 MagickBooleanType InvokeDynamicImageFilter(const char *tag,Image **image,
361 const int argc,const char **argv,ExceptionInfo *exception)
364 <p>A description of each parameter follows:</p>
367 <p>a character string that represents the name of the particular module.</p>
373 <p>a pointer to an integer describing the number of elements in the argument vector.</p>
376 <p>a pointer to a text array containing the command line arguments.</p>
379 <p>return any errors or warnings in this structure.</p>
382 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="ListModuleInfo">ListModuleInfo</a></h2>
383 <div class="doc-section">
385 <p>ListModuleInfo() lists the module info to a file.</p>
387 <p>The format of the ListModuleInfo module is:</p>
390 MagickBooleanType ListModuleInfo(FILE *file,ExceptionInfo *exception)
393 <p>A description of each parameter follows.</p>
396 <p>An pointer to a FILE.</p>
399 <p>return any errors or warnings in this structure.</p>
402 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="OpenModule">OpenModule</a></h2>
403 <div class="doc-section">
405 <p>OpenModule() loads a module, and invokes its registration module. It returns MagickTrue on success, and MagickFalse if there is an error.</p>
407 <p>The format of the OpenModule module is:</p>
410 MagickBooleanType OpenModule(const char *module,ExceptionInfo *exception)
413 <p>A description of each parameter follows:</p>
416 <p>a character string that indicates the module to load.</p>
419 <p>return any errors or warnings in this structure.</p>
422 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="OpenModules">OpenModules</a></h2>
423 <div class="doc-section">
425 <p>OpenModules() loads all available modules.</p>
427 <p>The format of the OpenModules module is:</p>
430 MagickBooleanType OpenModules(ExceptionInfo *exception)
433 <p>A description of each parameter follows:</p>
436 <p>return any errors or warnings in this structure.</p>
439 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="RegisterModule">RegisterModule</a></h2>
440 <div class="doc-section">
442 <p>RegisterModule() adds an entry to the module list. It returns a pointer to the registered entry on success.</p>
444 <p>The format of the RegisterModule module is:</p>
447 ModuleInfo *RegisterModule(const ModuleInfo *module_info,
448 ExceptionInfo *exception)
451 <p>A description of each parameter follows:</p>
454 <p>a pointer to the registered entry is returned.</p>
457 <p>a pointer to the ModuleInfo structure to register.</p>
460 <p>return any errors or warnings in this structure.</p>
463 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="TagToCoderModuleName">TagToCoderModuleName</a></h2>
464 <div class="doc-section">
466 <p>TagToCoderModuleName() munges a module tag and obtains the filename of the corresponding module.</p>
468 <p>The format of the TagToCoderModuleName module is:</p>
471 char *TagToCoderModuleName(const char *tag,char *name)
474 <p>A description of each parameter follows:</p>
477 <p>a character string representing the module tag.</p>
480 <p>return the module name here.</p>
483 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="TagToFilterModuleName">TagToFilterModuleName</a></h2>
484 <div class="doc-section">
486 <p>TagToFilterModuleName() munges a module tag and returns the filename of the corresponding filter module.</p>
488 <p>The format of the TagToFilterModuleName module is:</p>
491 void TagToFilterModuleName(const char *tag,char name)
494 <p>A description of each parameter follows:</p>
497 <p>a character string representing the module tag.</p>
500 <p>return the filter name here.</p>
503 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="TagToModuleName">TagToModuleName</a></h2>
504 <div class="doc-section">
506 <p>TagToModuleName() munges the module tag name and returns an upper-case tag name as the input string, and a user-provided format.</p>
508 <p>The format of the TagToModuleName module is:</p>
511 TagToModuleName(const char *tag,const char *format,char *module)
514 <p>A description of each parameter follows:</p>
517 <p>the module tag.</p>
520 <p>a sprintf-compatible format string containing s where the upper-case tag name is to be inserted.</p>
523 <p>pointer to a destination buffer for the formatted result.</p>
526 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="UnregisterModule">UnregisterModule</a></h2>
527 <div class="doc-section">
529 <p>UnregisterModule() unloads a module, and invokes its de-registration module. Returns MagickTrue on success, and MagickFalse if there is an error.</p>
531 <p>The format of the UnregisterModule module is:</p>
534 MagickBooleanType UnregisterModule(const ModuleInfo *module_info,
535 ExceptionInfo *exception)
538 <p>A description of each parameter follows:</p>
541 <p>the module info.</p>
544 <p>return any errors or warnings in this structure.</p>
551 <span id="linkbar-west"> </span>
\r
552 <span id="linkbar-center">
\r
553 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
\r
554 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
\r
556 <span id="linkbar-east"> </span>
\r
558 <div class="footer">
\r
559 <span id="footer-west">© 1999-2011 ImageMagick Studio LLC</span>
\r
560 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
\r
562 <div style="clear: both; margin: 0; width: 100%; "></div>
\r
563 <script type="text/javascript">
\r
564 var _gaq = _gaq || [];
\r
565 _gaq.push(['_setAccount', 'UA-17690367-1']);
\r
566 _gaq.push(['_trackPageview']);
\r
569 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
\r
570 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
\r
571 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
\r