granicus.if.org Git - imagemagick/blob - www/api/module.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   2   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   3 <html version="-//W3C//DTD XHTML 1.1//EN"
   4       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
   5       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   6       xsi:schemaLocation="http://www.w3.org/1999/xhtml
   7                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
   8 <head>
   9   <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
  10   <meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>
  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 automagically."/>
  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, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"/>
  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-2013 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="canonical" href="http://www.imagemagick.org" />
  31   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
  32   <!-- Add jQuery library -->
  33   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
  34
  35   <!-- Optionaly include easing and/or mousewheel plugins -->
  36   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.easing-1.3.pack.js"></script>
  37   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.mousewheel-3.0.6.pack.js"></script>
  38
  39   <!-- Add fancyBox -->
  40   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/jquery.fancybox.css?v=2.0.4" type="text/css" media="screen" />
  41   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox.pack.js?v=2.0.4"></script>
  42
  43   <!-- Optionaly include button and/or thumbnail helpers -->
  44   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.css?v=2.0.4" type="text/css" media="screen" />
  45   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.js?v=2.0.4"></script>
  46
  47   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.css?v=2.0.4" type="text/css" media="screen" />
  48   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.js?v=2.0.4"></script>
  49   <script type="text/javascript">
  50         $(document).ready(function() {
  51                 $(".fancybox").fancybox();
  52         });
  53   </script>
  54   <!-- ImageMagick style -->
  55   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
  56   <style type="text/css" media="all">
  57     @import url("../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick.css");
  58   </style>
  59 </head>
  60
  61 <body id="www-imagemagick-org">
  62 <div class="titlebar">
  63 <div style="margin: 17px auto; float: left;">
  64   <script type="text/javascript">
  65   <!--
  66     google_ad_client = "pub-3129977114552745";
  67     google_ad_slot = "5439289906";
  68     google_ad_width = 728;
  69     google_ad_height = 90;
  70   //-->
  71   </script>
  72   <script type="text/javascript"
  73     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
  74   </script>
  75 </div>
  76 <a href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../discourse-server">
  77   <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/logo.jpg"
  78   alt="ImageMagick Logo"
  79   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
  80 <a href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../index.html">
  81   <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/sprite.jpg"
  82   alt="ImageMagick Sprite"
  83   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
  84 </div>
  85
  86 <div class="westbar">
  87
  88 <div class="menu">
  89   <a title="About ImageMagick" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../index.html">About ImageMagick</a>
  90 </div>
  91 <div class="menu">
  92   <a title="Binary Releases" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html">Binary Releases</a>
  93 </div>
  94 <div class="sub">
  95     <a title="Binary Release: Unix" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#unix">Unix</a>
  96 </div>
  97 <div class="sub">
  98     <a title="Binary Release: MacOS X" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#macosx">Mac OS X</a>
  99 </div>
 100 <div class="sub">
 101     <a title="Binary Release: iOS" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#iOS">iOS</a>
 102 </div>
 103 <div class="sub">
 104     <a title="Binary Release: Windows" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#windows">Windows</a>
 105 </div>
 106 <div class="sep"></div>
 107 <div class="menu">
 108   <a title="Command-line Tools" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/command-line-tools.html">Command-line Tools</a>
 109 </div>
 110 <div class="sub">
 111     <a title="Command-line Tools: Processing" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/command-line-processing.html">Processing</a>
 112 </div>
 113 <div class="sub">
 114     <a title="Command-line Tools: Options" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/command-line-options.html">Options</a>
 115 </div>
 116 <div class="sub">
 117     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 118 </div>
 119 <div class="menu">
 120   <a title="Program Interfaces" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/api.html">Program Interfaces</a>
 121 </div>
 122 <div class="sub">
 123     <a title="Program Interface: MagickWand" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick-wand.html">MagickWand</a>
 124 </div>
 125 <div class="sub">
 126     <a title="Program Interface: MagickCore" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick-core.html">MagickCore</a>
 127 </div>
 128 <div class="sub">
 129     <a title="Program Interface: PerlMagick" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/perl-magick.html">PerlMagick</a>
 130 </div>
 131 <div class="sub">
 132     <a title="Program Interface: Magick++" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick++.html">Magick++</a>
 133 </div>
 134 <div class="sep"></div>
 135 <div  class="menu">
 136    <a title="Install from Source" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/install-source.html">Install from Source</a>
 137 </div>
 138 <div class="sub">
 139     <a title="Install from Source: Unix" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/install-source.html#unix">Unix</a>
 140 </div>
 141 <div class="sub">
 142     <a title="Install from Source: Windows" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/install-source.html#windows">Windows</a>
 143  </div>
 144 <div class="menu">
 145   <a title="Resources" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/resources.html">Resources</a>
 146 </div>
 147 <div class="menu">
 148   <a title="Architecture" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/architecture.html">Architecture</a>
 149 </div>
 150 <div class="menu">
 151   <a title="Download" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/download.html">Download</a>
 152 </div>
 153 <div class="sep"></div>
 154 <div class="menu">
 155   <a title="Search" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/search.html">Search</a>
 156 </div>
 157 <div class="sep"></div>
 158 <div class="menu">
 159   <a title="Site Map" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/sitemap.html">Site Map</a>
 160 </div>
 161 <div  class="sub">
 162   <a title="Site Map: Links" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/links.html">Links</a>
 163 </div>
 164 <div class="sep"></div>
 165 <div class="menu">
 166   <a rel="follow" title="Sponsors" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/sponsors.html">Sponsors:</a>
 167
 168   <a href="http://www.networkredux.com"> <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/networkredux.png" width="140" height="31" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
 169   <a href="http://www.dinodirect.com/ipads-tablets/"> <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/dino-direct.jpg" width="140" height="90" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a><!-- 201208010120 mickey@163... -->
 170 <div class="sponsbox">
 171 <div class="sponsor">
 172   <a rel="follow" title="Sponsor: The Fastest &amp; Easiest Way to Find Images" href="http://www.graphicsfactory.com">The Fastest &amp; Easiest Way to Find Images</a><!-- 201210010270 graphicsfac... -->
 173 </div>
 174 <div class="sponsor">
 175   <a rel="follow" title="Sponsor: VPS" href="http://www.interdominios.com/vps">VPS</a><!-- 201209010090 barsh@inter... -->
 176 </div>
 177 <div class="sponsor">
 178   <a rel="follow" title="Werbebanner Werbeplane" href="http://www.allesbanner.de">Werbebanner Werbeplane</a><!-- 201212010450 info@druck... -->
 179 </div>
 180 <div class="sponsor">
 181   <a rel="follow" title="Entertainment News &amp; Photos" href="http://www.zimbio.com">Entertainment News &amp; Photos</a><!-- 201211010540 bd@zimb... -->
 182 </div>
 183 <div class="sponsor">
 184   <a rel="follow" title="Sponsor: LED24" href="http://led24.de/">LED24</a><!-- 201207010270 info@led24... -->
 185 </div>
 186 <div class="sponsor">
 187   <a rel="follow" title="Sponsor: Best Website Hosting" href="http://www.top-cheap-web-hosting.com">Best Website Hosting</a><!-- 201304010090 eunge.liu-->
 188 </div>
 189 <div class="sponsor">
 190   <a rel="follow" title="Android Tablet" href="http://www.dinodirect.com/ipads-tablets/">Android Tablet</a><!-- 201208010120 mickey@163... -->
 191 </div>
 192 <div class="sponsor">
 193   <a rel="follow" title="Sponsor: Web Site Hosting" href="http://webhostinggeeks.com">Web Site Hosting</a><!-- 201302010900 funds@enmob... -->
 194 </div>
 195 <div class="sponsor">
 196    <a rel="follow" title="Sponsor: Premium Quality Stock Photos" href="http://www.f1online.pro/en/">Premium Quality Stock Photos</a><!-- 2012080100540 ... -->
 197 </div>
 198 <div class="sponsor">
 199    <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 2012070100250 ... -->
 200 </div>
 201 <div class="sponsor">
 202   <a rel="follow" title="Sponsor: Managed Server" href="http://www.robhost.de">Managed Server</a><!-- 201210010720 klikics... -->
 203 </div>
 204 <div class="sponsor">
 205   <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
 206 </div>
 207 <div class="sponsor">
 208    <a rel="follow" title="Sponsor: Notebook Reparatur" href="http://www.notebook-reparaturen-berlin.de">Notebook Reparatur</a><!-- 2012080100300 atlas-multimedia-->
 209 </div>
 210 <div class="sponsor">
 211    <a rel="follow" title="Sponsor: Fototapete - Tapetendruck" href="http://www.druck-expert.com/Fototapete-Tapetendruck,category,8830.html">Fototapete - Tapetendruck</a><!-- 2012100100155 info@druck-->
 212 </div>
 213 </div>
 214 </div>
 215 </div>
 216
 217 <div class="eastbar">
 218   <div class="g-plusone" id="gplusone"></div>
 219   <script type="text/javascript">
 220     window.___gcfg = {
 221       lang: 'en-US'
 222     };
 223
 224     (function() {
 225       var po = document.createElement('script');
 226       po.type = 'text/javascript'; po.async = true;
 227       po.src = 'https://apis.google.com/js/plusone.js';
 228       var script = document.getElementsByTagName('script')[0];
 229       script.parentNode.insertBefore(po, script);
 230     })();
 231     var gplusone = document.getElementById("gplusone");
 232     gplusone.setAttribute("data-size","medium");
 233     gplusone.setAttribute("data-count","false");
 234   </script>
 235 </div>
 236
 237 <div class="main">
 238
 239 <h1>Module module Methods</h1>
 240 <p class="navigation-index">[<a href="module.html#AcquireModuleInfo">AcquireModuleInfo</a> &bull; <a href="module.html#DestroyModuleList">DestroyModuleList</a> &bull; <a href="module.html#GetModuleInfo">GetModuleInfo</a> &bull; <a href="module.html#GetModuleInfoList">GetModuleInfoList</a> &bull; <a href="module.html#GetModuleList">GetModuleList</a> &bull; <a href="module.html#GetMagickModulePath">GetMagickModulePath</a> &bull; <a href="module.html#InitializeModuleList">InitializeModuleList</a> &bull; <a href="module.html#InvokeDynamicImageFilter">InvokeDynamicImageFilter</a> &bull; <a href="module.html#ListModuleInfo">ListModuleInfo</a> &bull; <a href="module.html#OpenModule">OpenModule</a> &bull; <a href="module.html#OpenModules">OpenModules</a> &bull; <a href="module.html#RegisterModule">RegisterModule</a> &bull; <a href="module.html#TagToCoderModuleName">TagToCoderModuleName</a> &bull; <a href="module.html#TagToFilterModuleName">TagToFilterModuleName</a> &bull; <a href="module.html#TagToModuleName">TagToModuleName</a> &bull; <a href="module.html#UnregisterModule">UnregisterModule</a>]</p>
 241
 242 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="AcquireModuleInfo">AcquireModuleInfo</a></h2>
 243 <div class="doc-section">
 244
 245 <p>AcquireModuleInfo() allocates the ModuleInfo structure.</p>
 246
 247 <p>The format of the AcquireModuleInfo method is:</p>
 248
 249 <pre class="code">
 250   ModuleInfo *AcquireModuleInfo(const char *path,const char *tag)
 251 </pre>
 252
 253 <p>A description of each parameter follows:</p>
 254
 255 <h5>path</h5>
 256 <p>the path associated with the tag.</p>
 257
 258 <h5>tag</h5>
 259 <p>a character string that represents the image format we are looking for.</p>
 260
 261  </div>
 262 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="DestroyModuleList">DestroyModuleList</a></h2>
 263 <div class="doc-section">
 264
 265 <p>DestroyModuleList() unregisters any previously loaded modules and exits the module loaded environment.</p>
 266
 267 <p>The format of the DestroyModuleList module is:</p>
 268
 269 <pre class="text">
 270   void DestroyModuleList(void)
 271 </pre>
 272
 273  </div>
 274 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="GetModuleInfo">GetModuleInfo</a></h2>
 275 <div class="doc-section">
 276
 277 <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>
 278
 279 <p>The format of the GetModuleInfo module is:</p>
 280
 281 <pre class="text">
 282   ModuleInfo *GetModuleInfo(const char *tag,ExceptionInfo *exception)
 283 </pre>
 284
 285 <p>A description of each parameter follows:</p>
 286
 287 <h5>tag</h5>
 288 <p>a character string that represents the image format we are looking for.</p>
 289
 290 <h5>exception</h5>
 291 <p>return any errors or warnings in this structure.</p>
 292
 293  </div>
 294 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="GetModuleInfoList">GetModuleInfoList</a></h2>
 295 <div class="doc-section">
 296
 297 <p>GetModuleInfoList() returns any modules that match the specified pattern.</p>
 298
 299 <p>The format of the GetModuleInfoList function is:</p>
 300
 301 <pre class="text">
 302   const ModuleInfo **GetModuleInfoList(const char *pattern,
 303     size_t *number_modules,ExceptionInfo *exception)
 304 </pre>
 305
 306 <p>A description of each parameter follows:</p>
 307
 308 <h5>pattern</h5>
 309 <p>Specifies a pointer to a text string containing a pattern.</p>
 310
 311 <h5>number_modules</h5>
 312 <p>This integer returns the number of modules in the list.</p>
 313
 314 <h5>exception</h5>
 315 <p>return any errors or warnings in this structure.</p>
 316
 317  </div>
 318 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="GetModuleList">GetModuleList</a></h2>
 319 <div class="doc-section">
 320
 321 <p>GetModuleList() returns any image format modules that match the specified pattern.</p>
 322
 323 <p>The format of the GetModuleList function is:</p>
 324
 325 <pre class="text">
 326   char **GetModuleList(const char *pattern,const MagickModuleType type,
 327     size_t *number_modules,ExceptionInfo *exception)
 328 </pre>
 329
 330 <p>A description of each parameter follows:</p>
 331
 332 <h5>pattern</h5>
 333 <p>Specifies a pointer to a text string containing a pattern.</p>
 334
 335 <h5>type</h5>
 336 <p>choose from MagickImageCoderModule or MagickImageFilterModule.</p>
 337
 338 <h5>number_modules</h5>
 339 <p>This integer returns the number of modules in the list.</p>
 340
 341 <h5>exception</h5>
 342 <p>return any errors or warnings in this structure.</p>
 343
 344  </div>
 345 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="GetMagickModulePath">GetMagickModulePath</a></h2>
 346 <div class="doc-section">
 347
 348 <p>GetMagickModulePath() finds a module with the specified module type and filename.</p>
 349
 350 <p>The format of the GetMagickModulePath module is:</p>
 351
 352 <pre class="text">
 353   MagickBooleanType GetMagickModulePath(const char *filename,
 354     MagickModuleType module_type,char *path,ExceptionInfo *exception)
 355 </pre>
 356
 357 <p>A description of each parameter follows:</p>
 358
 359 <h5>filename</h5>
 360 <p>the module file name.</p>
 361
 362 <h5>module_type</h5>
 363 <p>the module type: MagickImageCoderModule or MagickImageFilterModule.</p>
 364
 365 <h5>path</h5>
 366 <p>the path associated with the filename.</p>
 367
 368 <h5>exception</h5>
 369 <p>return any errors or warnings in this structure.</p>
 370
 371  </div>
 372 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="InitializeModuleList">InitializeModuleList</a></h2>
 373 <div class="doc-section">
 374
 375 <p>InitializeModuleList() initializes the module loader.</p>
 376
 377 <p>The format of the InitializeModuleList() method is:</p>
 378
 379 <pre class="code">
 380   InitializeModuleList(Exceptioninfo *exception)
 381 </pre>
 382
 383 <p>A description of each parameter follows.</p>
 384
 385 <h5>exception</h5>
 386 <p>return any errors or warnings in this structure.</p>
 387
 388  </div>
 389 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="InvokeDynamicImageFilter">InvokeDynamicImageFilter</a></h2>
 390 <div class="doc-section">
 391
 392 <p>InvokeDynamicImageFilter() invokes a dynamic image filter.</p>
 393
 394 <p>The format of the InvokeDynamicImageFilter module is:</p>
 395
 396 <pre class="text">
 397   MagickBooleanType InvokeDynamicImageFilter(const char *tag,Image **image,
 398     const int argc,const char **argv,ExceptionInfo *exception)
 399 </pre>
 400
 401 <p>A description of each parameter follows:</p>
 402
 403 <h5>tag</h5>
 404 <p>a character string that represents the name of the particular module.</p>
 405
 406 <h5>image</h5>
 407 <p>the image.</p>
 408
 409 <h5>argc</h5>
 410 <p>a pointer to an integer describing the number of elements in the argument vector.</p>
 411
 412 <h5>argv</h5>
 413 <p>a pointer to a text array containing the command line arguments.</p>
 414
 415 <h5>exception</h5>
 416 <p>return any errors or warnings in this structure.</p>
 417
 418  </div>
 419 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="ListModuleInfo">ListModuleInfo</a></h2>
 420 <div class="doc-section">
 421
 422 <p>ListModuleInfo() lists the module info to a file.</p>
 423
 424 <p>The format of the ListModuleInfo module is:</p>
 425
 426 <pre class="text">
 427   MagickBooleanType ListModuleInfo(FILE *file,ExceptionInfo *exception)
 428 </pre>
 429
 430 <p>A description of each parameter follows.</p>
 431
 432 <h5>file</h5>
 433 <p>An pointer to a FILE.</p>
 434
 435 <h5>exception</h5>
 436 <p>return any errors or warnings in this structure.</p>
 437
 438  </div>
 439 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="OpenModule">OpenModule</a></h2>
 440 <div class="doc-section">
 441
 442 <p>OpenModule() loads a module, and invokes its registration module.  It returns MagickTrue on success, and MagickFalse if there is an error.</p>
 443
 444 <p>The format of the OpenModule module is:</p>
 445
 446 <pre class="text">
 447   MagickBooleanType OpenModule(const char *module,ExceptionInfo *exception)
 448 </pre>
 449
 450 <p>A description of each parameter follows:</p>
 451
 452 <h5>module</h5>
 453 <p>a character string that indicates the module to load.</p>
 454
 455 <h5>exception</h5>
 456 <p>return any errors or warnings in this structure.</p>
 457
 458  </div>
 459 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="OpenModules">OpenModules</a></h2>
 460 <div class="doc-section">
 461
 462 <p>OpenModules() loads all available modules.</p>
 463
 464 <p>The format of the OpenModules module is:</p>
 465
 466 <pre class="text">
 467   MagickBooleanType OpenModules(ExceptionInfo *exception)
 468 </pre>
 469
 470 <p>A description of each parameter follows:</p>
 471
 472 <h5>exception</h5>
 473 <p>return any errors or warnings in this structure.</p>
 474
 475  </div>
 476 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="RegisterModule">RegisterModule</a></h2>
 477 <div class="doc-section">
 478
 479 <p>RegisterModule() adds an entry to the module list.  It returns a pointer to the registered entry on success.</p>
 480
 481 <p>The format of the RegisterModule module is:</p>
 482
 483 <pre class="text">
 484   ModuleInfo *RegisterModule(const ModuleInfo *module_info,
 485     ExceptionInfo *exception)
 486 </pre>
 487
 488 <p>A description of each parameter follows:</p>
 489
 490 <h5>info</h5>
 491 <p>a pointer to the registered entry is returned.</p>
 492
 493 <h5>module_info</h5>
 494 <p>a pointer to the ModuleInfo structure to register.</p>
 495
 496 <h5>exception</h5>
 497 <p>return any errors or warnings in this structure.</p>
 498
 499  </div>
 500 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="TagToCoderModuleName">TagToCoderModuleName</a></h2>
 501 <div class="doc-section">
 502
 503 <p>TagToCoderModuleName() munges a module tag and obtains the filename of the corresponding module.</p>
 504
 505 <p>The format of the TagToCoderModuleName module is:</p>
 506
 507 <pre class="text">
 508   char *TagToCoderModuleName(const char *tag,char *name)
 509 </pre>
 510
 511 <p>A description of each parameter follows:</p>
 512
 513 <h5>tag</h5>
 514 <p>a character string representing the module tag.</p>
 515
 516 <h5>name</h5>
 517 <p>return the module name here.</p>
 518
 519  </div>
 520 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="TagToFilterModuleName">TagToFilterModuleName</a></h2>
 521 <div class="doc-section">
 522
 523 <p>TagToFilterModuleName() munges a module tag and returns the filename of the corresponding filter module.</p>
 524
 525 <p>The format of the TagToFilterModuleName module is:</p>
 526
 527 <pre class="text">
 528   void TagToFilterModuleName(const char *tag,char name)
 529 </pre>
 530
 531 <p>A description of each parameter follows:</p>
 532
 533 <h5>tag</h5>
 534 <p>a character string representing the module tag.</p>
 535
 536 <h5>name</h5>
 537 <p>return the filter name here.</p>
 538
 539  </div>
 540 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="TagToModuleName">TagToModuleName</a></h2>
 541 <div class="doc-section">
 542
 543 <p>TagToModuleName() munges the module tag name and returns an upper-case tag name as the input string, and a user-provided format.</p>
 544
 545 <p>The format of the TagToModuleName module is:</p>
 546
 547 <pre class="text">
 548   TagToModuleName(const char *tag,const char *format,char *module)
 549 </pre>
 550
 551 <p>A description of each parameter follows:</p>
 552
 553 <h5>tag</h5>
 554 <p>the module tag.</p>
 555
 556 <h5>format</h5>
 557 <p>a sprintf-compatible format string containing s where the upper-case tag name is to be inserted.</p>
 558
 559 <h5>module</h5>
 560 <p>pointer to a destination buffer for the formatted result.</p>
 561
 562  </div>
 563 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="UnregisterModule">UnregisterModule</a></h2>
 564 <div class="doc-section">
 565
 566 <p>UnregisterModule() unloads a module, and invokes its de-registration module. Returns MagickTrue on success, and MagickFalse if there is an error.</p>
 567
 568 <p>The format of the UnregisterModule module is:</p>
 569
 570 <pre class="text">
 571   MagickBooleanType UnregisterModule(const ModuleInfo *module_info,
 572     ExceptionInfo *exception)
 573 </pre>
 574
 575 <p>A description of each parameter follows:</p>
 576
 577 <h5>module_info</h5>
 578 <p>the module info.</p>
 579
 580 <h5>exception</h5>
 581 <p>return any errors or warnings in this structure.</p>
 582
 583  </div>
 584
 585 </div>
 586
 587 <div id="linkbar">
 588     <span id="linkbar-west">&nbsp;</span>
 589     <span id="linkbar-center">
 590       <a href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../discourse-server">Discourse Server</a> &bull;
 591       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
 592     </span>
 593     <span id="linkbar-east">&nbsp;</span>
 594   </div>
 595   <div class="footer">
 596     <span id="footer-west">&copy; 1999-2013 ImageMagick Studio LLC</span>
 597     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
 598   </div>
 599   <div style="clear: both; margin: 0; width: 100%; "></div>
 600   <script type="text/javascript">
 601     var _gaq = _gaq || [];
 602     _gaq.push(['_setAccount', 'UA-17690367-1']);
 603     _gaq.push(['_trackPageview']);
 604
 605     (function() {
 606       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
 607       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
 608       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
 609     })();
 610   </script>
 611 </body>
 612 </html>