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

   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">\r
   4 <head>\r
   5   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />\r
   6   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   7   <style type="text/css" media="screen,projection"><!--\r
   8     @import url("../../www/magick.css");\r
   9   --></style>\r
  10   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  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="Generator" content="PHP"/>
  16   <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"/>
  17   <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."/>
  18   <meta name="Rating" content="GENERAL"/>
  19   <meta name="Robots" content="INDEX, FOLLOW"/>
  20   <meta name="Generator" content="ImageMagick Studio LLC"/>
  21   <meta name="Author" content="ImageMagick Studio LLC"/>
  22   <meta name="Revisit-after" content="2 DAYS"/>
  23   <meta name="Resource-type" content="document"/>
  24   <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
  25   <meta name="Distribution" content="Global"/>
  26 </head>\r
  27 \r
  28 <body id="www-imagemagick-org">\r
  29 <div class="titlebar">\r
  30 <a href="../../index.html">\r
  31   <img src="../../images/script.png" alt="[ImageMagick]"\r
  32   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  33 <a href="http://www.networkredux.com">\r
  34   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  35   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  36 <a href="http://www.imagemagick.org/discourse-server/">\r
  37   <img src="../../images/logo.jpg" alt=""\r
  38   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  39 <a href="../../index.html">\r
  40   <img src="../../images/sprite.jpg" alt=""\r
  41   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  42 </div>\r
  43 \r
  44 <div class="eastbar">\r
  45 \r
  46 <div class="menu">
  47   <a href="../../index.html">About ImageMagick</a>
  48 </div>
  49 <div class="sep"></div>\r
  50 <div class="menu">
  51   <a href="../../www/command-line-tools.html">Command-line Tools</a>
  52 </div>
  53 <div class="sub">
  54     <a href="../../www/command-line-processing.html">Processing</a>
  55 </div>
  56 <div class="sub">
  57     <a href="../../www/command-line-options.html">Options</a>
  58 </div>
  59 <div class="sub">
  60     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  61 </div>
  62 <div class="menu">
  63   <a href="../../www/api.html">Program Interfaces</a>
  64 </div>
  65 <div class="sub">
  66     <a href="../../www/magick-wand.html">MagickWand</a>
  67 </div>
  68 <div class="sub">
  69     <a href="../../www/magick-core.html">MagickCore</a>
  70 </div>
  71 <div class="sub">
  72     <a href="../../www/perl-magick.html">PerlMagick</a>
  73 </div>
  74 <div class="sub">
  75     <a href="../../Magick++/">Magick++</a>
  76 </div>
  77 <div class="menu">
  78   <a href="../../www/architecture.html">Architecture</a>
  79 </div>
  80 <div class="sep"></div>\r
  81 <div  class="menu">
  82    <a href="../../www/install-source.html">Install from Source</a>
  83 </div>
  84 <div class="sub">
  85     <a href="../../www/install-source.html#unix">Unix</a>
  86 </div>
  87 <div class="sub">
  88     <a href="../../www/install-source.html#windows">Windows</a>
  89  </div>
  90 <div class="menu">
  91   <a href="../../www/binary-releases.html">Binary Releases</a>
  92 </div>
  93 <div class="sub">
  94     <a href="../../www/binary-releases.html#unix">Unix</a>
  95 </div>
  96 <div class="sub">
  97     <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
  98 </div>
  99 <div class="sub">
 100     <a href="../../www/binary-releases.html#windows">Windows</a>
 101 </div>
 102 <div class="menu">
 103   <a href="../../www/resources.html">Resources</a>
 104 </div>
 105 <div class="sep"></div>\r
 106 <div class="menu">
 107   <a href="../../www/download.html">Download</a>
 108 </div>
 109 <div class="sep"></div>\r
 110 <div class="menu">
 111   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
 112 </div>
 113 <div class="sep"></div>\r
 114 <div class="menu">
 115   <a href="../../www/sitemap.html">Site Map</a>
 116 </div>
 117 <div  class="sub">
 118     <a href="../../www/links.html">Links</a>
 119 </div>
 120 <div class="sep"></div>\r
 121 <div  class="menu">
 122   <a href="../../www/sponsors.html">Sponsors:</a>
 123
 124 <div class="sponsbox">
 125 <div  class="sponsor">
 126    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 127 </div>
 128 <div  class="sponsor">
 129   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
 130 </div>
 131 <div  class="sponsor">
 132   <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
 133 </div>
 134 <div  class="sponsor">
 135   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 136 </div>
 137 <div  class="sponsor">
 138   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201001010120 Buchhorn -->
 139 </div>
 140 </div>
 141 </div>
 142 \r
 143 \r
 144 </div>\r
 145 \r
 146 <div class="main">\r
 147 \r
 148 <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="#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>
 149
 150 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 151 _8c.html" target="source" name="AcquireModuleInfo">AcquireModuleInfo</a></h2>
 152 <div class="doc-section">
 153
 154 <p>AcquireModuleInfo() allocates the ModuleInfo structure.</p></ol>
 155
 156 <p>The format of the AcquireModuleInfo method is:</p>
 157
 158 <pre class="code">
 159   ModuleInfo *AcquireModuleInfo(const char *path,const char *tag)
 160 </pre>
 161
 162 <p>A description of each parameter follows:</p></ol>
 163
 164 <h5>path</h5>
 165 <ol><p>the path associated with the tag.</p></ol>
 166
 167 <h5>tag</h5>
 168 <ol><p>a character string that represents the image format we are looking for.</p></ol>
 169
 170  </div>
 171 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 172 _8c.html" target="source" name="DestroyModuleList">DestroyModuleList</a></h2>
 173 <div class="doc-section">
 174
 175 <p>DestroyModuleList() unregisters any previously loaded modules and exits the module loaded environment.</p></ol>
 176
 177 <p>The format of the DestroyModuleList module is:</p>
 178
 179 <pre class="text">
 180   void DestroyModuleList(void)
 181 </pre>
 182
 183  </div>
 184 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 185 _8c.html" target="source" name="GetModuleInfo">GetModuleInfo</a></h2>
 186 <div class="doc-section">
 187
 188 <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>
 189
 190 <p>The format of the GetModuleInfo module is:</p>
 191
 192 <pre class="text">
 193   ModuleInfo *GetModuleInfo(const char *tag,ExceptionInfo *exception)
 194 </pre>
 195
 196 <p>A description of each parameter follows:</p></ol>
 197
 198 <h5>tag</h5>
 199 <ol><p>a character string that represents the image format we are looking for.</p></ol>
 200
 201 <h5>exception</h5>
 202 <ol><p>return any errors or warnings in this structure.</p></ol>
 203
 204  </div>
 205 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 206 _8c.html" target="source" name="GetModuleInfoList">GetModuleInfoList</a></h2>
 207 <div class="doc-section">
 208
 209 <p>GetModuleInfoList() returns any modules that match the specified pattern.</p></ol>
 210
 211 <p>The format of the GetModuleInfoList function is:</p>
 212
 213 <pre class="text">
 214   const ModuleInfo **GetModuleInfoList(const char *pattern,
 215     unsigned long *number_modules,ExceptionInfo *exception)
 216 </pre>
 217
 218 <p>A description of each parameter follows:</p></ol>
 219
 220 <h5>pattern</h5>
 221 <ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
 222
 223 <h5>number_modules</h5>
 224 <ol><p>This integer returns the number of modules in the list.</p></ol>
 225
 226 <h5>exception</h5>
 227 <ol><p>return any errors or warnings in this structure.</p></ol>
 228
 229  </div>
 230 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 231 _8c.html" target="source" name="GetModuleList">GetModuleList</a></h2>
 232 <div class="doc-section">
 233
 234 <p>GetModuleList() returns any image format modules that match the specified pattern.</p></ol>
 235
 236 <p>The format of the GetModuleList function is:</p>
 237
 238 <pre class="text">
 239   char **GetModuleList(const char *pattern,unsigned long *number_modules,
 240     ExceptionInfo *exception)
 241 </pre>
 242
 243 <p>A description of each parameter follows:</p></ol>
 244
 245 <h5>pattern</h5>
 246 <ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
 247
 248 <h5>number_modules</h5>
 249 <ol><p>This integer returns the number of modules in the list.</p></ol>
 250
 251 <h5>exception</h5>
 252 <ol><p>return any errors or warnings in this structure.</p></ol>
 253
 254  </div>
 255 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 256 _8c.html" target="source" name="GetMagickModulePath">GetMagickModulePath</a></h2>
 257 <div class="doc-section">
 258
 259 <p>GetMagickModulePath() finds a module with the specified module type and filename.</p></ol>
 260
 261 <p>The format of the GetMagickModulePath module is:</p>
 262
 263 <pre class="text">
 264   MagickBooleanType GetMagickModulePath(const char *filename,
 265     MagickModuleType module_type,char *path,ExceptionInfo *exception)
 266 </pre>
 267
 268 <p>A description of each parameter follows:</p></ol>
 269
 270 <h5>filename</h5>
 271 <ol><p>the module file name.</p></ol>
 272
 273 <h5>module_type</h5>
 274 <ol><p>the module type: MagickImageCoderModule or MagickImageFilterModule.</p></ol>
 275
 276 <h5>path</h5>
 277 <ol><p>the path associated with the filename.</p></ol>
 278
 279 <h5>exception</h5>
 280 <ol><p>return any errors or warnings in this structure.</p></ol>
 281
 282  </div>
 283 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 284 _8c.html" target="source" name="InvokeDynamicImageFilter">InvokeDynamicImageFilter</a></h2>
 285 <div class="doc-section">
 286
 287 <p>InvokeDynamicImageFilter() invokes a dynamic image filter.</p></ol>
 288
 289 <p>The format of the InvokeDynamicImageFilter module is:</p>
 290
 291 <pre class="text">
 292   MagickBooleanType InvokeDynamicImageFilter(const char *tag,Image **image,
 293     const int argc,const char **argv,ExceptionInfo *exception)
 294 </pre>
 295
 296 <p>A description of each parameter follows:</p></ol>
 297
 298 <h5>tag</h5>
 299 <ol><p>a character string that represents the name of the particular module.</p></ol>
 300
 301 <h5>image</h5>
 302 <ol><p>the image.</p></ol>
 303
 304 <h5>argc</h5>
 305 <ol><p>a pointer to an integer describing the number of elements in the argument vector.</p></ol>
 306
 307 <h5>argv</h5>
 308 <ol><p>a pointer to a text array containing the command line arguments.</p></ol>
 309
 310 <h5>exception</h5>
 311 <ol><p>return any errors or warnings in this structure.</p></ol>
 312
 313  </div>
 314 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 315 _8c.html" target="source" name="ListModuleInfo">ListModuleInfo</a></h2>
 316 <div class="doc-section">
 317
 318 <p>ListModuleInfo() lists the module info to a file.</p></ol>
 319
 320 <p>The format of the ListModuleInfo module is:</p>
 321
 322 <pre class="text">
 323   MagickBooleanType ListModuleInfo(FILE *file,ExceptionInfo *exception)
 324 </pre>
 325
 326 <p>A description of each parameter follows.</p></ol>
 327
 328 <h5>file</h5>
 329 <ol><p>An pointer to a FILE.</p></ol>
 330
 331 <h5>exception</h5>
 332 <ol><p>return any errors or warnings in this structure.</p></ol>
 333
 334  </div>
 335 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 336 _8c.html" target="source" name="OpenModule">OpenModule</a></h2>
 337 <div class="doc-section">
 338
 339 <p>OpenModule() loads a module, and invokes its registration module.  It returns MagickTrue on success, and MagickFalse if there is an error.</p></ol>
 340
 341 <p>The format of the OpenModule module is:</p>
 342
 343 <pre class="text">
 344   MagickBooleanType OpenModule(const char *module,ExceptionInfo *exception)
 345 </pre>
 346
 347 <p>A description of each parameter follows:</p></ol>
 348
 349 <h5>module</h5>
 350 <ol><p>a character string that indicates the module to load.</p></ol>
 351
 352 <h5>exception</h5>
 353 <ol><p>return any errors or warnings in this structure.</p></ol>
 354
 355  </div>
 356 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 357 _8c.html" target="source" name="OpenModules">OpenModules</a></h2>
 358 <div class="doc-section">
 359
 360 <p>OpenModules() loads all available modules.</p></ol>
 361
 362 <p>The format of the OpenModules module is:</p>
 363
 364 <pre class="text">
 365   MagickBooleanType OpenModules(ExceptionInfo *exception)
 366 </pre>
 367
 368 <p>A description of each parameter follows:</p></ol>
 369
 370 <h5>exception</h5>
 371 <ol><p>return any errors or warnings in this structure.</p></ol>
 372
 373  </div>
 374 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 375 _8c.html" target="source" name="RegisterModule">RegisterModule</a></h2>
 376 <div class="doc-section">
 377
 378 <p>RegisterModule() adds an entry to the module list.  It returns a pointer to the registered entry on success.</p></ol>
 379
 380 <p>The format of the RegisterModule module is:</p>
 381
 382 <pre class="text">
 383   ModuleInfo *RegisterModule(const ModuleInfo *module_info,
 384     ExceptionInfo *exception)
 385 </pre>
 386
 387 <p>A description of each parameter follows:</p></ol>
 388
 389 <h5>info</h5>
 390 <ol><p>a pointer to the registered entry is returned.</p></ol>
 391
 392 <h5>module_info</h5>
 393 <ol><p>a pointer to the ModuleInfo structure to register.</p></ol>
 394
 395 <h5>exception</h5>
 396 <ol><p>return any errors or warnings in this structure.</p></ol>
 397
 398  </div>
 399 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 400 _8c.html" target="source" name="TagToCoderModuleName">TagToCoderModuleName</a></h2>
 401 <div class="doc-section">
 402
 403 <p>TagToCoderModuleName() munges a module tag and obtains the filename of the corresponding module.</p></ol>
 404
 405 <p>The format of the TagToCoderModuleName module is:</p>
 406
 407 <pre class="text">
 408   char *TagToCoderModuleName(const char *tag,char *name)
 409 </pre>
 410
 411 <p>A description of each parameter follows:</p></ol>
 412
 413 <h5>tag</h5>
 414 <ol><p>a character string representing the module tag.</p></ol>
 415
 416 <h5>name</h5>
 417 <ol><p>return the module name here.</p></ol>
 418
 419  </div>
 420 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 421 _8c.html" target="source" name="TagToFilterModuleName">TagToFilterModuleName</a></h2>
 422 <div class="doc-section">
 423
 424 <p>TagToFilterModuleName() munges a module tag and returns the filename of the corresponding filter module.</p></ol>
 425
 426 <p>The format of the TagToFilterModuleName module is:</p>
 427
 428 <pre class="text">
 429   void TagToFilterModuleName(const char *tag,char name)
 430 </pre>
 431
 432 <p>A description of each parameter follows:</p></ol>
 433
 434 <h5>tag</h5>
 435 <ol><p>a character string representing the module tag.</p></ol>
 436
 437 <h5>name</h5>
 438 <ol><p>return the filter name here.</p></ol>
 439
 440  </div>
 441 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 442 _8c.html" target="source" name="TagToModuleName">TagToModuleName</a></h2>
 443 <div class="doc-section">
 444
 445 <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>
 446
 447 <p>The format of the TagToModuleName module is:</p>
 448
 449 <pre class="text">
 450   TagToModuleName(const char *tag,const char *format,char *module)
 451 </pre>
 452
 453 <p>A description of each parameter follows:</p></ol>
 454
 455 <h5>tag</h5>
 456 <ol><p>the module tag.</p></ol>
 457
 458 <h5>format</h5>
 459 <ol><p>a sprintf-compatible format string containing s where the upper-case tag name is to be inserted.</p></ol>
 460
 461 <h5>module</h5>
 462 <ol><p>pointer to a destination buffer for the formatted result.</p></ol>
 463
 464  </div>
 465 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 466 _8c.html" target="source" name="UnregisterModule">UnregisterModule</a></h2>
 467 <div class="doc-section">
 468
 469 <p>UnregisterModule() unloads a module, and invokes its de-registration module. Returns MagickTrue on success, and MagickFalse if there is an error.</p></ol>
 470
 471 <p>The format of the UnregisterModule module is:</p>
 472
 473 <pre class="text">
 474   MagickBooleanType UnregisterModule(const ModuleInfo *module_info,
 475     ExceptionInfo *exception)
 476 </pre>
 477
 478 <p>A description of each parameter follows:</p></ol>
 479
 480 <h5>module_info</h5>
 481 <ol><p>the module info.</p></ol>
 482
 483 <h5>exception</h5>
 484 <ol><p>return any errors or warnings in this structure.</p></ol>
 485
 486  </div>
 487 \r
 488 </div>\r
 489 \r
 490 <div id="linkbar">\r
 491  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 492     <span id="linkbar-center">\r
 493       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 494       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
 495     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 496     </span>\r
 497     <span id="linkbar-east">&nbsp;</span>\r
 498   </div>\r
 499   <div class="footer">\r
 500     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
 501     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 502   </div>\r
 503   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 504 </body>\r
 505 </html>\r