1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
\r
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
\r
5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
\r
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
\r
7 <title>ImageMagick: MagickCore, C API for ImageMagick: Loadable Modules</title/>
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"/>
11 <meta name="Application-name" content="ImageMagick"/>
12 <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves. ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems. The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
13 <meta name="Application-url" content="http://www.imagemagick.org"/>
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"/>
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"/>
22 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
23 <meta name="Distribution" content="Global"/>
24 <link rel="icon" href="../../images/wand.png" sizes="32x32"/>
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"/>
\r
27 <style type="text/css" media="all">
\r
28 @import url("../../www/magick.css");
\r
32 <body id="www-imagemagick-org">
\r
33 <div class="titlebar">
\r
34 <a href="../../index.html">
\r
35 <img src="../../images/script.png" alt="[ImageMagick]"
\r
36 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
\r
37 <a href="http://www.networkredux.com">
\r
38 <img src="../../images/networkredux.png" alt="[sponsor]"
\r
39 style="margin: 45px auto; border: 0px; float: left;" /></a>
\r
40 <a href="http://www.imagemagick.org/discourse-server/">
\r
41 <img src="../../images/logo.jpg" alt=""
\r
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
43 <a href="../../index.html">
\r
44 <img src="../../images/sprite.jpg" alt=""
\r
45 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
48 <div class="westbar">
\r
51 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
53 <div class="sep"></div>
\r
55 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
58 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
61 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
64 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
66 <div class="sep"></div>
\r
68 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
71 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
74 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
77 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
80 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
83 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
86 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
89 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
92 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
94 <div class="sep"></div>
\r
96 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
99 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
102 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
105 <a title="Resources" href="../../www/resources.html">Resources</a>
108 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
111 <a title="Download" href="../../www/download.html">Download</a>
113 <div class="sep"></div>
\r
115 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
117 <div class="sep"></div>
\r
119 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
122 <a title="Site Map: Links"href="../../www/links.html">Links</a>
124 <div class="sep"></div>
\r
126 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
128 <div class="sponsbox">
129 <div class="sponsor">
130 <a title="Sponsor: Webdesign" href="http://www.renehornig.com/">Webdesign</a><!-- 20111001000240 -->
132 <div class="sponsor">
133 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
135 <div class="sponsor">
136 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
138 <div class="sponsor">
139 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
141 <div class="sponsor">
142 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
144 <div class="sponsor">
145 <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
147 <div class="sponsor">
148 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
154 <div class="eastbar">
\r
155 <script type="text/javascript">
\r
157 google_ad_client = "pub-3129977114552745";
\r
158 google_ad_slot = "0574824969";
\r
159 google_ad_width = 160;
\r
160 google_ad_height = 600;
\r
163 <script type="text/javascript"
\r
164 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
\r
170 <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>
172 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
173 _8c.html" target="source" name="AcquireModuleInfo">AcquireModuleInfo</a></h2>
174 <div class="doc-section">
176 <p>AcquireModuleInfo() allocates the ModuleInfo structure.</p></ol>
178 <p>The format of the AcquireModuleInfo method is:</p>
181 ModuleInfo *AcquireModuleInfo(const char *path,const char *tag)
184 <p>A description of each parameter follows:</p></ol>
187 <ol><p>the path associated with the tag.</p></ol>
190 <ol><p>a character string that represents the image format we are looking for.</p></ol>
193 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
194 _8c.html" target="source" name="DestroyModuleList">DestroyModuleList</a></h2>
195 <div class="doc-section">
197 <p>DestroyModuleList() unregisters any previously loaded modules and exits the module loaded environment.</p></ol>
199 <p>The format of the DestroyModuleList module is:</p>
202 void DestroyModuleList(void)
206 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
207 _8c.html" target="source" name="GetModuleInfo">GetModuleInfo</a></h2>
208 <div class="doc-section">
210 <p>GetModuleInfo() returns a pointer to a ModuleInfo structure that matches the specified tag. If tag is NULL, the head of the module list is returned. If no modules are loaded, or the requested module is not found, NULL is returned.</p></ol>
212 <p>The format of the GetModuleInfo module is:</p>
215 ModuleInfo *GetModuleInfo(const char *tag,ExceptionInfo *exception)
218 <p>A description of each parameter follows:</p></ol>
221 <ol><p>a character string that represents the image format we are looking for.</p></ol>
224 <ol><p>return any errors or warnings in this structure.</p></ol>
227 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
228 _8c.html" target="source" name="GetModuleInfoList">GetModuleInfoList</a></h2>
229 <div class="doc-section">
231 <p>GetModuleInfoList() returns any modules that match the specified pattern.</p></ol>
233 <p>The format of the GetModuleInfoList function is:</p>
236 const ModuleInfo **GetModuleInfoList(const char *pattern,
237 size_t *number_modules,ExceptionInfo *exception)
240 <p>A description of each parameter follows:</p></ol>
243 <ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
245 <h5>number_modules</h5>
246 <ol><p>This integer returns the number of modules in the list.</p></ol>
249 <ol><p>return any errors or warnings in this structure.</p></ol>
252 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
253 _8c.html" target="source" name="GetModuleList">GetModuleList</a></h2>
254 <div class="doc-section">
256 <p>GetModuleList() returns any image format modules that match the specified pattern.</p></ol>
258 <p>The format of the GetModuleList function is:</p>
261 char **GetModuleList(const char *pattern,const MagickModuleType type,
262 size_t *number_modules,ExceptionInfo *exception)
265 <p>A description of each parameter follows:</p></ol>
268 <ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
271 <ol><p>choose from MagickImageCoderModule or MagickImageFilterModule.</p></ol>
273 <h5>number_modules</h5>
274 <ol><p>This integer returns the number of modules in the list.</p></ol>
277 <ol><p>return any errors or warnings in this structure.</p></ol>
280 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
281 _8c.html" target="source" name="GetMagickModulePath">GetMagickModulePath</a></h2>
282 <div class="doc-section">
284 <p>GetMagickModulePath() finds a module with the specified module type and filename.</p></ol>
286 <p>The format of the GetMagickModulePath module is:</p>
289 MagickBooleanType GetMagickModulePath(const char *filename,
290 MagickModuleType module_type,char *path,ExceptionInfo *exception)
293 <p>A description of each parameter follows:</p></ol>
296 <ol><p>the module file name.</p></ol>
299 <ol><p>the module type: MagickImageCoderModule or MagickImageFilterModule.</p></ol>
302 <ol><p>the path associated with the filename.</p></ol>
305 <ol><p>return any errors or warnings in this structure.</p></ol>
308 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
309 _8c.html" target="source" name="InitializeModuleList">InitializeModuleList</a></h2>
310 <div class="doc-section">
312 <p>InitializeModuleList() initializes the module loader.</p></ol>
314 <p>The format of the InitializeModuleList() method is:</p>
317 InitializeModuleList(Exceptioninfo *exception)
320 <p>A description of each parameter follows.</p></ol>
323 <ol><p>return any errors or warnings in this structure.</p></ol>
326 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
327 _8c.html" target="source" name="InvokeDynamicImageFilter">InvokeDynamicImageFilter</a></h2>
328 <div class="doc-section">
330 <p>InvokeDynamicImageFilter() invokes a dynamic image filter.</p></ol>
332 <p>The format of the InvokeDynamicImageFilter module is:</p>
335 MagickBooleanType InvokeDynamicImageFilter(const char *tag,Image **image,
336 const int argc,const char **argv,ExceptionInfo *exception)
339 <p>A description of each parameter follows:</p></ol>
342 <ol><p>a character string that represents the name of the particular module.</p></ol>
345 <ol><p>the image.</p></ol>
348 <ol><p>a pointer to an integer describing the number of elements in the argument vector.</p></ol>
351 <ol><p>a pointer to a text array containing the command line arguments.</p></ol>
354 <ol><p>return any errors or warnings in this structure.</p></ol>
357 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
358 _8c.html" target="source" name="ListModuleInfo">ListModuleInfo</a></h2>
359 <div class="doc-section">
361 <p>ListModuleInfo() lists the module info to a file.</p></ol>
363 <p>The format of the ListModuleInfo module is:</p>
366 MagickBooleanType ListModuleInfo(FILE *file,ExceptionInfo *exception)
369 <p>A description of each parameter follows.</p></ol>
372 <ol><p>An pointer to a FILE.</p></ol>
375 <ol><p>return any errors or warnings in this structure.</p></ol>
378 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
379 _8c.html" target="source" name="OpenModule">OpenModule</a></h2>
380 <div class="doc-section">
382 <p>OpenModule() loads a module, and invokes its registration module. It returns MagickTrue on success, and MagickFalse if there is an error.</p></ol>
384 <p>The format of the OpenModule module is:</p>
387 MagickBooleanType OpenModule(const char *module,ExceptionInfo *exception)
390 <p>A description of each parameter follows:</p></ol>
393 <ol><p>a character string that indicates the module to load.</p></ol>
396 <ol><p>return any errors or warnings in this structure.</p></ol>
399 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
400 _8c.html" target="source" name="OpenModules">OpenModules</a></h2>
401 <div class="doc-section">
403 <p>OpenModules() loads all available modules.</p></ol>
405 <p>The format of the OpenModules module is:</p>
408 MagickBooleanType OpenModules(ExceptionInfo *exception)
411 <p>A description of each parameter follows:</p></ol>
414 <ol><p>return any errors or warnings in this structure.</p></ol>
417 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
418 _8c.html" target="source" name="RegisterModule">RegisterModule</a></h2>
419 <div class="doc-section">
421 <p>RegisterModule() adds an entry to the module list. It returns a pointer to the registered entry on success.</p></ol>
423 <p>The format of the RegisterModule module is:</p>
426 ModuleInfo *RegisterModule(const ModuleInfo *module_info,
427 ExceptionInfo *exception)
430 <p>A description of each parameter follows:</p></ol>
433 <ol><p>a pointer to the registered entry is returned.</p></ol>
436 <ol><p>a pointer to the ModuleInfo structure to register.</p></ol>
439 <ol><p>return any errors or warnings in this structure.</p></ol>
442 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
443 _8c.html" target="source" name="TagToCoderModuleName">TagToCoderModuleName</a></h2>
444 <div class="doc-section">
446 <p>TagToCoderModuleName() munges a module tag and obtains the filename of the corresponding module.</p></ol>
448 <p>The format of the TagToCoderModuleName module is:</p>
451 char *TagToCoderModuleName(const char *tag,char *name)
454 <p>A description of each parameter follows:</p></ol>
457 <ol><p>a character string representing the module tag.</p></ol>
460 <ol><p>return the module name here.</p></ol>
463 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
464 _8c.html" target="source" name="TagToFilterModuleName">TagToFilterModuleName</a></h2>
465 <div class="doc-section">
467 <p>TagToFilterModuleName() munges a module tag and returns the filename of the corresponding filter module.</p></ol>
469 <p>The format of the TagToFilterModuleName module is:</p>
472 void TagToFilterModuleName(const char *tag,char name)
475 <p>A description of each parameter follows:</p></ol>
478 <ol><p>a character string representing the module tag.</p></ol>
481 <ol><p>return the filter name here.</p></ol>
484 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
485 _8c.html" target="source" name="TagToModuleName">TagToModuleName</a></h2>
486 <div class="doc-section">
488 <p>TagToModuleName() munges the module tag name and returns an upper-case tag name as the input string, and a user-provided format.</p></ol>
490 <p>The format of the TagToModuleName module is:</p>
493 TagToModuleName(const char *tag,const char *format,char *module)
496 <p>A description of each parameter follows:</p></ol>
499 <ol><p>the module tag.</p></ol>
502 <ol><p>a sprintf-compatible format string containing s where the upper-case tag name is to be inserted.</p></ol>
505 <ol><p>pointer to a destination buffer for the formatted result.</p></ol>
508 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
509 _8c.html" target="source" name="UnregisterModule">UnregisterModule</a></h2>
510 <div class="doc-section">
512 <p>UnregisterModule() unloads a module, and invokes its de-registration module. Returns MagickTrue on success, and MagickFalse if there is an error.</p></ol>
514 <p>The format of the UnregisterModule module is:</p>
517 MagickBooleanType UnregisterModule(const ModuleInfo *module_info,
518 ExceptionInfo *exception)
521 <p>A description of each parameter follows:</p></ol>
524 <ol><p>the module info.</p></ol>
527 <ol><p>return any errors or warnings in this structure.</p></ol>
534 <span id="linkbar-west"> </span>
\r
535 <span id="linkbar-center">
\r
536 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
\r
537 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
\r
539 <span id="linkbar-east"> </span>
\r
541 <div class="footer">
\r
542 <span id="footer-west">© 1999-2010 ImageMagick Studio LLC</span>
\r
543 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
\r
545 <div style="clear: both; margin: 0; width: 100%; "></div>
\r
546 <script type="text/javascript">
\r
547 var _gaq = _gaq || [];
\r
548 _gaq.push(['_setAccount', 'UA-17690367-1']);
\r
549 _gaq.push(['_trackPageview']);
\r
552 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
\r
553 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
\r
554 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
\r