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

   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
   8 <head>\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 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, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Image, Processing, Automagically"/>
  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
  34   </style>\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
  44         'opacity'       : true\r
  45       });\r
  46     });\r
  47   </script>\r
  48 </head>\r
  49 \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
  54   <!--\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
  59   //-->\r
  60   </script>\r
  61   <script type="text/javascript"\r
  62     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
  63   </script>\r
  64 </div>\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
  73 </div>\r
  74 \r
  75 <div class="westbar">\r
  76 \r
  77 <div class="menu">
  78   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  79 </div>
  80 <div class="sep"></div>\r
  81 <div class="menu">
  82   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  83 </div>
  84 <div class="sub">
  85     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  86 </div>
  87 <div class="sub">
  88     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  89 </div>
  90 <div class="sub">
  91     <a title="Binary Release: iOS" href="../../www/binary-releases.html#iOS">iOS</a>
  92 </div>
  93 <div class="sub">
  94     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
  95 </div>
  96 <div class="sep"></div>\r
  97 <div class="menu">
  98   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  99 </div>
 100 <div class="sub">
 101     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
 102 </div>
 103 <div class="sub">
 104     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
 105 </div>
 106 <div class="sub">
 107     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 108 </div>
 109 <div class="menu">
 110   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
 111 </div>
 112 <div class="sub">
 113     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
 114 </div>
 115 <div class="sub">
 116     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
 117 </div>
 118 <div class="sub">
 119     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
 120 </div>
 121 <div class="sub">
 122     <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
 123 </div>
 124 <div class="sep"></div>\r
 125 <div  class="menu">
 126    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
 127 </div>
 128 <div class="sub">
 129     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
 130 </div>
 131 <div class="sub">
 132     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 133  </div>
 134 <div class="menu">
 135   <a title="Resources" href="../../www/resources.html">Resources</a>
 136 </div>
 137 <div class="menu">
 138   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 139 </div>
 140 <div class="menu">
 141   <a title="Download" href="../../www/download.html">Download</a>
 142 </div>
 143 <div class="sep"></div>\r
 144 <div class="menu">
 145   <a title="Search" href="../../www/search.html">Search</a>
 146 </div>
 147 <div class="sep"></div>\r
 148 <div class="menu">
 149   <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
 150 </div>
 151 <div  class="sub">
 152   <a title="Site Map: Links" href="../../www/links.html">Links</a>
 153 </div>
 154 <div class="sep"></div>\r
 155 <div  class="menu">
 156   <a rel="follow" title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 157
 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" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan -->
 164 </div>
 165 <div  class="sponsor">
 166   <a rel="follow" title="Sponsor: Search engine optimisation" href="http://www.seomoves.com.au">Search engine optimisation</a><!-- 201110010090s jen@seo lowprofilelinks -->
 167 </div>
 168 <div  class="sponsor">
 169   <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 170 </div>
 171 <div  class="sponsor">
 172   <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin -->
 173 </div>
 174 <div  class="sponsor">
 175   <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry -->
 176 </div>
 177 <div  class="sponsor">
 178   <a rel="follow" title="Sponsor: Web Hosting Break" href="http://www.webhostingbreak.com">Web Hosting Break</a><!-- 201109010090 ian@ian-m... -->
 179 </div>
 180 <div  class="sponsor">
 181   <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
 182 </div>
 183 <div  class="sponsor">
 184   <a rel="follow" title="Sponsor: Website Hosting" href="http://www.hostreviewgeeks.com">Website Hosting</a><!-- 201110010090 alexanian media -->
 185 </div>
 186 <div  class="sponsor">
 187   <a rel="follow" title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb -->
 188 </div>
 189 <div  class="sponsor">
 190   <a rel="follow" title="Sponsor: Best Web Hosting" href="http://webhostinggeeks.com">Best Web Hosting</a><!-- 201110010720 -->
 191 </div>
 192 <div  class="sponsor">
 193   <a rel="follow" title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 194 </div>
 195 <div  class="sponsor">
 196   <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingmasters.com">Web Hosting Reviews</a><!-- 201107011500 affliatelabel -->
 197 </div>
 198 <div  class="sponsor">
 199   <a rel="follow" title="Sponsor: Web Hosting Ratings" href="http://webhostingrating.com">Web Hosting Ratings</a><!-- 201110010720 -->
 200 </div>
 201 <div  class="sponsor">
 202    <a rel="follow" title="Sponsor: alaTest.com" href="http://alatest.com">alaTest.com</a><!-- 20110801000300 -->
 203 </div>
 204 </div>
 205 </div>
 206 </div>\r
 207 \r
 208 <div class="eastbar">\r
 209 \r
 210 </div>\r
 211 \r
 212 <div class="main">\r
 213 \r
 214 <h1>Module module Methods</h1>
 215 <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>
 216
 217 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="AcquireModuleInfo">AcquireModuleInfo</a></h2>
 218 <div class="doc-section">
 219
 220 <p>AcquireModuleInfo() allocates the ModuleInfo structure.</p>
 221
 222 <p>The format of the AcquireModuleInfo method is:</p>
 223
 224 <pre class="code">
 225   ModuleInfo *AcquireModuleInfo(const char *path,const char *tag)
 226 </pre>
 227
 228 <p>A description of each parameter follows:</p>
 229
 230 <h5>path</h5>
 231 <p>the path associated with the tag.</p>
 232
 233 <h5>tag</h5>
 234 <p>a character string that represents the image format we are looking for.</p>
 235
 236  </div>
 237 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="DestroyModuleList">DestroyModuleList</a></h2>
 238 <div class="doc-section">
 239
 240 <p>DestroyModuleList() unregisters any previously loaded modules and exits the module loaded environment.</p>
 241
 242 <p>The format of the DestroyModuleList module is:</p>
 243
 244 <pre class="text">
 245   void DestroyModuleList(void)
 246 </pre>
 247
 248  </div>
 249 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="GetModuleInfo">GetModuleInfo</a></h2>
 250 <div class="doc-section">
 251
 252 <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>
 253
 254 <p>The format of the GetModuleInfo module is:</p>
 255
 256 <pre class="text">
 257   ModuleInfo *GetModuleInfo(const char *tag,ExceptionInfo *exception)
 258 </pre>
 259
 260 <p>A description of each parameter follows:</p>
 261
 262 <h5>tag</h5>
 263 <p>a character string that represents the image format we are looking for.</p>
 264
 265 <h5>exception</h5>
 266 <p>return any errors or warnings in this structure.</p>
 267
 268  </div>
 269 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="GetModuleInfoList">GetModuleInfoList</a></h2>
 270 <div class="doc-section">
 271
 272 <p>GetModuleInfoList() returns any modules that match the specified pattern.</p>
 273
 274 <p>The format of the GetModuleInfoList function is:</p>
 275
 276 <pre class="text">
 277   const ModuleInfo **GetModuleInfoList(const char *pattern,
 278     size_t *number_modules,ExceptionInfo *exception)
 279 </pre>
 280
 281 <p>A description of each parameter follows:</p>
 282
 283 <h5>pattern</h5>
 284 <p>Specifies a pointer to a text string containing a pattern.</p>
 285
 286 <h5>number_modules</h5>
 287 <p>This integer returns the number of modules in the list.</p>
 288
 289 <h5>exception</h5>
 290 <p>return any errors or warnings in this structure.</p>
 291
 292  </div>
 293 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="GetModuleList">GetModuleList</a></h2>
 294 <div class="doc-section">
 295
 296 <p>GetModuleList() returns any image format modules that match the specified pattern.</p>
 297
 298 <p>The format of the GetModuleList function is:</p>
 299
 300 <pre class="text">
 301   char **GetModuleList(const char *pattern,const MagickModuleType type,
 302     size_t *number_modules,ExceptionInfo *exception)
 303 </pre>
 304
 305 <p>A description of each parameter follows:</p>
 306
 307 <h5>pattern</h5>
 308 <p>Specifies a pointer to a text string containing a pattern.</p>
 309
 310 <h5>type</h5>
 311 <p>choose from MagickImageCoderModule or MagickImageFilterModule.</p>
 312
 313 <h5>number_modules</h5>
 314 <p>This integer returns the number of modules in the list.</p>
 315
 316 <h5>exception</h5>
 317 <p>return any errors or warnings in this structure.</p>
 318
 319  </div>
 320 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="GetMagickModulePath">GetMagickModulePath</a></h2>
 321 <div class="doc-section">
 322
 323 <p>GetMagickModulePath() finds a module with the specified module type and filename.</p>
 324
 325 <p>The format of the GetMagickModulePath module is:</p>
 326
 327 <pre class="text">
 328   MagickBooleanType GetMagickModulePath(const char *filename,
 329     MagickModuleType module_type,char *path,ExceptionInfo *exception)
 330 </pre>
 331
 332 <p>A description of each parameter follows:</p>
 333
 334 <h5>filename</h5>
 335 <p>the module file name.</p>
 336
 337 <h5>module_type</h5>
 338 <p>the module type: MagickImageCoderModule or MagickImageFilterModule.</p>
 339
 340 <h5>path</h5>
 341 <p>the path associated with the filename.</p>
 342
 343 <h5>exception</h5>
 344 <p>return any errors or warnings in this structure.</p>
 345
 346  </div>
 347 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="InitializeModuleList">InitializeModuleList</a></h2>
 348 <div class="doc-section">
 349
 350 <p>InitializeModuleList() initializes the module loader.</p>
 351
 352 <p>The format of the InitializeModuleList() method is:</p>
 353
 354 <pre class="code">
 355   InitializeModuleList(Exceptioninfo *exception)
 356 </pre>
 357
 358 <p>A description of each parameter follows.</p>
 359
 360 <h5>exception</h5>
 361 <p>return any errors or warnings in this structure.</p>
 362
 363  </div>
 364 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="InvokeDynamicImageFilter">InvokeDynamicImageFilter</a></h2>
 365 <div class="doc-section">
 366
 367 <p>InvokeDynamicImageFilter() invokes a dynamic image filter.</p>
 368
 369 <p>The format of the InvokeDynamicImageFilter module is:</p>
 370
 371 <pre class="text">
 372   MagickBooleanType InvokeDynamicImageFilter(const char *tag,Image **image,
 373     const int argc,const char **argv,ExceptionInfo *exception)
 374 </pre>
 375
 376 <p>A description of each parameter follows:</p>
 377
 378 <h5>tag</h5>
 379 <p>a character string that represents the name of the particular module.</p>
 380
 381 <h5>image</h5>
 382 <p>the image.</p>
 383
 384 <h5>argc</h5>
 385 <p>a pointer to an integer describing the number of elements in the argument vector.</p>
 386
 387 <h5>argv</h5>
 388 <p>a pointer to a text array containing the command line arguments.</p>
 389
 390 <h5>exception</h5>
 391 <p>return any errors or warnings in this structure.</p>
 392
 393  </div>
 394 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="ListModuleInfo">ListModuleInfo</a></h2>
 395 <div class="doc-section">
 396
 397 <p>ListModuleInfo() lists the module info to a file.</p>
 398
 399 <p>The format of the ListModuleInfo module is:</p>
 400
 401 <pre class="text">
 402   MagickBooleanType ListModuleInfo(FILE *file,ExceptionInfo *exception)
 403 </pre>
 404
 405 <p>A description of each parameter follows.</p>
 406
 407 <h5>file</h5>
 408 <p>An pointer to a FILE.</p>
 409
 410 <h5>exception</h5>
 411 <p>return any errors or warnings in this structure.</p>
 412
 413  </div>
 414 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="OpenModule">OpenModule</a></h2>
 415 <div class="doc-section">
 416
 417 <p>OpenModule() loads a module, and invokes its registration module.  It returns MagickTrue on success, and MagickFalse if there is an error.</p>
 418
 419 <p>The format of the OpenModule module is:</p>
 420
 421 <pre class="text">
 422   MagickBooleanType OpenModule(const char *module,ExceptionInfo *exception)
 423 </pre>
 424
 425 <p>A description of each parameter follows:</p>
 426
 427 <h5>module</h5>
 428 <p>a character string that indicates the module to load.</p>
 429
 430 <h5>exception</h5>
 431 <p>return any errors or warnings in this structure.</p>
 432
 433  </div>
 434 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="OpenModules">OpenModules</a></h2>
 435 <div class="doc-section">
 436
 437 <p>OpenModules() loads all available modules.</p>
 438
 439 <p>The format of the OpenModules module is:</p>
 440
 441 <pre class="text">
 442   MagickBooleanType OpenModules(ExceptionInfo *exception)
 443 </pre>
 444
 445 <p>A description of each parameter follows:</p>
 446
 447 <h5>exception</h5>
 448 <p>return any errors or warnings in this structure.</p>
 449
 450  </div>
 451 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="RegisterModule">RegisterModule</a></h2>
 452 <div class="doc-section">
 453
 454 <p>RegisterModule() adds an entry to the module list.  It returns a pointer to the registered entry on success.</p>
 455
 456 <p>The format of the RegisterModule module is:</p>
 457
 458 <pre class="text">
 459   ModuleInfo *RegisterModule(const ModuleInfo *module_info,
 460     ExceptionInfo *exception)
 461 </pre>
 462
 463 <p>A description of each parameter follows:</p>
 464
 465 <h5>info</h5>
 466 <p>a pointer to the registered entry is returned.</p>
 467
 468 <h5>module_info</h5>
 469 <p>a pointer to the ModuleInfo structure to register.</p>
 470
 471 <h5>exception</h5>
 472 <p>return any errors or warnings in this structure.</p>
 473
 474  </div>
 475 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="TagToCoderModuleName">TagToCoderModuleName</a></h2>
 476 <div class="doc-section">
 477
 478 <p>TagToCoderModuleName() munges a module tag and obtains the filename of the corresponding module.</p>
 479
 480 <p>The format of the TagToCoderModuleName module is:</p>
 481
 482 <pre class="text">
 483   char *TagToCoderModuleName(const char *tag,char *name)
 484 </pre>
 485
 486 <p>A description of each parameter follows:</p>
 487
 488 <h5>tag</h5>
 489 <p>a character string representing the module tag.</p>
 490
 491 <h5>name</h5>
 492 <p>return the module name here.</p>
 493
 494  </div>
 495 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="TagToFilterModuleName">TagToFilterModuleName</a></h2>
 496 <div class="doc-section">
 497
 498 <p>TagToFilterModuleName() munges a module tag and returns the filename of the corresponding filter module.</p>
 499
 500 <p>The format of the TagToFilterModuleName module is:</p>
 501
 502 <pre class="text">
 503   void TagToFilterModuleName(const char *tag,char name)
 504 </pre>
 505
 506 <p>A description of each parameter follows:</p>
 507
 508 <h5>tag</h5>
 509 <p>a character string representing the module tag.</p>
 510
 511 <h5>name</h5>
 512 <p>return the filter name here.</p>
 513
 514  </div>
 515 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="TagToModuleName">TagToModuleName</a></h2>
 516 <div class="doc-section">
 517
 518 <p>TagToModuleName() munges the module tag name and returns an upper-case tag name as the input string, and a user-provided format.</p>
 519
 520 <p>The format of the TagToModuleName module is:</p>
 521
 522 <pre class="text">
 523   TagToModuleName(const char *tag,const char *format,char *module)
 524 </pre>
 525
 526 <p>A description of each parameter follows:</p>
 527
 528 <h5>tag</h5>
 529 <p>the module tag.</p>
 530
 531 <h5>format</h5>
 532 <p>a sprintf-compatible format string containing s where the upper-case tag name is to be inserted.</p>
 533
 534 <h5>module</h5>
 535 <p>pointer to a destination buffer for the formatted result.</p>
 536
 537  </div>
 538 <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="UnregisterModule">UnregisterModule</a></h2>
 539 <div class="doc-section">
 540
 541 <p>UnregisterModule() unloads a module, and invokes its de-registration module. Returns MagickTrue on success, and MagickFalse if there is an error.</p>
 542
 543 <p>The format of the UnregisterModule module is:</p>
 544
 545 <pre class="text">
 546   MagickBooleanType UnregisterModule(const ModuleInfo *module_info,
 547     ExceptionInfo *exception)
 548 </pre>
 549
 550 <p>A description of each parameter follows:</p>
 551
 552 <h5>module_info</h5>
 553 <p>the module info.</p>
 554
 555 <h5>exception</h5>
 556 <p>return any errors or warnings in this structure.</p>
 557
 558  </div>
 559 \r
 560 </div>\r
 561 \r
 562 <div id="linkbar">\r
 563     <span id="linkbar-west">&nbsp;</span>\r
 564     <span id="linkbar-center">\r
 565       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 566       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 567     </span>\r
 568     <span id="linkbar-east">&nbsp;</span>\r
 569   </div>\r
 570   <div class="footer">\r
 571     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
 572     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 573   </div>\r
 574   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 575   <script type="text/javascript">\r
 576     var _gaq = _gaq || [];\r
 577     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 578     _gaq.push(['_trackPageview']);\r
 579 \r
 580     (function() {\r
 581       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 582       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 583       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 584     })();\r
 585   </script>\r
 586 </body>\r
 587 </html>\r