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.buerodruck.de/stempel-service/index.html">Stempel bestellen</a><!-- 200910000035+ -->
 127 </div>
 128 <div  class="sponsor">
 129   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201003010120 Buchhorn -->
 130 </div>
 131 <div  class="sponsor">
 132   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 133 </div>
 134 <div  class="sponsor">
 135    <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
 136 </div>
 137 <div  class="sponsor">
 138    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 139 </div>
 140 <div  class="sponsor">
 141   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
 142 </div>
 143 <div  class="sponsor">
 144   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 145 </div>
 146 </div>
 147 </div>
 148 \r
 149 \r
 150 </div>\r
 151 \r
 152 <div class="main">\r
 153 \r
 154 <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>
 155
 156 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 157 _8c.html" target="source" name="AcquireModuleInfo">AcquireModuleInfo</a></h2>
 158 <div class="doc-section">
 159
 160 <p>AcquireModuleInfo() allocates the ModuleInfo structure.</p></ol>
 161
 162 <p>The format of the AcquireModuleInfo method is:</p>
 163
 164 <pre class="code">
 165   ModuleInfo *AcquireModuleInfo(const char *path,const char *tag)
 166 </pre>
 167
 168 <p>A description of each parameter follows:</p></ol>
 169
 170 <h5>path</h5>
 171 <ol><p>the path associated with the tag.</p></ol>
 172
 173 <h5>tag</h5>
 174 <ol><p>a character string that represents the image format we are looking for.</p></ol>
 175
 176  </div>
 177 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 178 _8c.html" target="source" name="DestroyModuleList">DestroyModuleList</a></h2>
 179 <div class="doc-section">
 180
 181 <p>DestroyModuleList() unregisters any previously loaded modules and exits the module loaded environment.</p></ol>
 182
 183 <p>The format of the DestroyModuleList module is:</p>
 184
 185 <pre class="text">
 186   void DestroyModuleList(void)
 187 </pre>
 188
 189  </div>
 190 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 191 _8c.html" target="source" name="GetModuleInfo">GetModuleInfo</a></h2>
 192 <div class="doc-section">
 193
 194 <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>
 195
 196 <p>The format of the GetModuleInfo module is:</p>
 197
 198 <pre class="text">
 199   ModuleInfo *GetModuleInfo(const char *tag,ExceptionInfo *exception)
 200 </pre>
 201
 202 <p>A description of each parameter follows:</p></ol>
 203
 204 <h5>tag</h5>
 205 <ol><p>a character string that represents the image format we are looking for.</p></ol>
 206
 207 <h5>exception</h5>
 208 <ol><p>return any errors or warnings in this structure.</p></ol>
 209
 210  </div>
 211 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 212 _8c.html" target="source" name="GetModuleInfoList">GetModuleInfoList</a></h2>
 213 <div class="doc-section">
 214
 215 <p>GetModuleInfoList() returns any modules that match the specified pattern.</p></ol>
 216
 217 <p>The format of the GetModuleInfoList function is:</p>
 218
 219 <pre class="text">
 220   const ModuleInfo **GetModuleInfoList(const char *pattern,
 221     unsigned long *number_modules,ExceptionInfo *exception)
 222 </pre>
 223
 224 <p>A description of each parameter follows:</p></ol>
 225
 226 <h5>pattern</h5>
 227 <ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
 228
 229 <h5>number_modules</h5>
 230 <ol><p>This integer returns the number of modules in the list.</p></ol>
 231
 232 <h5>exception</h5>
 233 <ol><p>return any errors or warnings in this structure.</p></ol>
 234
 235  </div>
 236 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 237 _8c.html" target="source" name="GetModuleList">GetModuleList</a></h2>
 238 <div class="doc-section">
 239
 240 <p>GetModuleList() returns any image format modules that match the specified pattern.</p></ol>
 241
 242 <p>The format of the GetModuleList function is:</p>
 243
 244 <pre class="text">
 245   char **GetModuleList(const char *pattern,unsigned long *number_modules,
 246     ExceptionInfo *exception)
 247 </pre>
 248
 249 <p>A description of each parameter follows:</p></ol>
 250
 251 <h5>pattern</h5>
 252 <ol><p>Specifies a pointer to a text string containing a pattern.</p></ol>
 253
 254 <h5>number_modules</h5>
 255 <ol><p>This integer returns the number of modules in the list.</p></ol>
 256
 257 <h5>exception</h5>
 258 <ol><p>return any errors or warnings in this structure.</p></ol>
 259
 260  </div>
 261 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 262 _8c.html" target="source" name="GetMagickModulePath">GetMagickModulePath</a></h2>
 263 <div class="doc-section">
 264
 265 <p>GetMagickModulePath() finds a module with the specified module type and filename.</p></ol>
 266
 267 <p>The format of the GetMagickModulePath module is:</p>
 268
 269 <pre class="text">
 270   MagickBooleanType GetMagickModulePath(const char *filename,
 271     MagickModuleType module_type,char *path,ExceptionInfo *exception)
 272 </pre>
 273
 274 <p>A description of each parameter follows:</p></ol>
 275
 276 <h5>filename</h5>
 277 <ol><p>the module file name.</p></ol>
 278
 279 <h5>module_type</h5>
 280 <ol><p>the module type: MagickImageCoderModule or MagickImageFilterModule.</p></ol>
 281
 282 <h5>path</h5>
 283 <ol><p>the path associated with the filename.</p></ol>
 284
 285 <h5>exception</h5>
 286 <ol><p>return any errors or warnings in this structure.</p></ol>
 287
 288  </div>
 289 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 290 _8c.html" target="source" name="InvokeDynamicImageFilter">InvokeDynamicImageFilter</a></h2>
 291 <div class="doc-section">
 292
 293 <p>InvokeDynamicImageFilter() invokes a dynamic image filter.</p></ol>
 294
 295 <p>The format of the InvokeDynamicImageFilter module is:</p>
 296
 297 <pre class="text">
 298   MagickBooleanType InvokeDynamicImageFilter(const char *tag,Image **image,
 299     const int argc,const char **argv,ExceptionInfo *exception)
 300 </pre>
 301
 302 <p>A description of each parameter follows:</p></ol>
 303
 304 <h5>tag</h5>
 305 <ol><p>a character string that represents the name of the particular module.</p></ol>
 306
 307 <h5>image</h5>
 308 <ol><p>the image.</p></ol>
 309
 310 <h5>argc</h5>
 311 <ol><p>a pointer to an integer describing the number of elements in the argument vector.</p></ol>
 312
 313 <h5>argv</h5>
 314 <ol><p>a pointer to a text array containing the command line arguments.</p></ol>
 315
 316 <h5>exception</h5>
 317 <ol><p>return any errors or warnings in this structure.</p></ol>
 318
 319  </div>
 320 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 321 _8c.html" target="source" name="ListModuleInfo">ListModuleInfo</a></h2>
 322 <div class="doc-section">
 323
 324 <p>ListModuleInfo() lists the module info to a file.</p></ol>
 325
 326 <p>The format of the ListModuleInfo module is:</p>
 327
 328 <pre class="text">
 329   MagickBooleanType ListModuleInfo(FILE *file,ExceptionInfo *exception)
 330 </pre>
 331
 332 <p>A description of each parameter follows.</p></ol>
 333
 334 <h5>file</h5>
 335 <ol><p>An pointer to a FILE.</p></ol>
 336
 337 <h5>exception</h5>
 338 <ol><p>return any errors or warnings in this structure.</p></ol>
 339
 340  </div>
 341 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 342 _8c.html" target="source" name="OpenModule">OpenModule</a></h2>
 343 <div class="doc-section">
 344
 345 <p>OpenModule() loads a module, and invokes its registration module.  It returns MagickTrue on success, and MagickFalse if there is an error.</p></ol>
 346
 347 <p>The format of the OpenModule module is:</p>
 348
 349 <pre class="text">
 350   MagickBooleanType OpenModule(const char *module,ExceptionInfo *exception)
 351 </pre>
 352
 353 <p>A description of each parameter follows:</p></ol>
 354
 355 <h5>module</h5>
 356 <ol><p>a character string that indicates the module to load.</p></ol>
 357
 358 <h5>exception</h5>
 359 <ol><p>return any errors or warnings in this structure.</p></ol>
 360
 361  </div>
 362 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 363 _8c.html" target="source" name="OpenModules">OpenModules</a></h2>
 364 <div class="doc-section">
 365
 366 <p>OpenModules() loads all available modules.</p></ol>
 367
 368 <p>The format of the OpenModules module is:</p>
 369
 370 <pre class="text">
 371   MagickBooleanType OpenModules(ExceptionInfo *exception)
 372 </pre>
 373
 374 <p>A description of each parameter follows:</p></ol>
 375
 376 <h5>exception</h5>
 377 <ol><p>return any errors or warnings in this structure.</p></ol>
 378
 379  </div>
 380 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 381 _8c.html" target="source" name="RegisterModule">RegisterModule</a></h2>
 382 <div class="doc-section">
 383
 384 <p>RegisterModule() adds an entry to the module list.  It returns a pointer to the registered entry on success.</p></ol>
 385
 386 <p>The format of the RegisterModule module is:</p>
 387
 388 <pre class="text">
 389   ModuleInfo *RegisterModule(const ModuleInfo *module_info,
 390     ExceptionInfo *exception)
 391 </pre>
 392
 393 <p>A description of each parameter follows:</p></ol>
 394
 395 <h5>info</h5>
 396 <ol><p>a pointer to the registered entry is returned.</p></ol>
 397
 398 <h5>module_info</h5>
 399 <ol><p>a pointer to the ModuleInfo structure to register.</p></ol>
 400
 401 <h5>exception</h5>
 402 <ol><p>return any errors or warnings in this structure.</p></ol>
 403
 404  </div>
 405 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 406 _8c.html" target="source" name="TagToCoderModuleName">TagToCoderModuleName</a></h2>
 407 <div class="doc-section">
 408
 409 <p>TagToCoderModuleName() munges a module tag and obtains the filename of the corresponding module.</p></ol>
 410
 411 <p>The format of the TagToCoderModuleName module is:</p>
 412
 413 <pre class="text">
 414   char *TagToCoderModuleName(const char *tag,char *name)
 415 </pre>
 416
 417 <p>A description of each parameter follows:</p></ol>
 418
 419 <h5>tag</h5>
 420 <ol><p>a character string representing the module tag.</p></ol>
 421
 422 <h5>name</h5>
 423 <ol><p>return the module name here.</p></ol>
 424
 425  </div>
 426 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 427 _8c.html" target="source" name="TagToFilterModuleName">TagToFilterModuleName</a></h2>
 428 <div class="doc-section">
 429
 430 <p>TagToFilterModuleName() munges a module tag and returns the filename of the corresponding filter module.</p></ol>
 431
 432 <p>The format of the TagToFilterModuleName module is:</p>
 433
 434 <pre class="text">
 435   void TagToFilterModuleName(const char *tag,char name)
 436 </pre>
 437
 438 <p>A description of each parameter follows:</p></ol>
 439
 440 <h5>tag</h5>
 441 <ol><p>a character string representing the module tag.</p></ol>
 442
 443 <h5>name</h5>
 444 <ol><p>return the filter name here.</p></ol>
 445
 446  </div>
 447 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 448 _8c.html" target="source" name="TagToModuleName">TagToModuleName</a></h2>
 449 <div class="doc-section">
 450
 451 <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>
 452
 453 <p>The format of the TagToModuleName module is:</p>
 454
 455 <pre class="text">
 456   TagToModuleName(const char *tag,const char *format,char *module)
 457 </pre>
 458
 459 <p>A description of each parameter follows:</p></ol>
 460
 461 <h5>tag</h5>
 462 <ol><p>the module tag.</p></ol>
 463
 464 <h5>format</h5>
 465 <ol><p>a sprintf-compatible format string containing s where the upper-case tag name is to be inserted.</p></ol>
 466
 467 <h5>module</h5>
 468 <ol><p>pointer to a destination buffer for the formatted result.</p></ol>
 469
 470  </div>
 471 <h2><a href="http://www.imagemagick.org/api/MagickCore/module
 472 _8c.html" target="source" name="UnregisterModule">UnregisterModule</a></h2>
 473 <div class="doc-section">
 474
 475 <p>UnregisterModule() unloads a module, and invokes its de-registration module. Returns MagickTrue on success, and MagickFalse if there is an error.</p></ol>
 476
 477 <p>The format of the UnregisterModule module is:</p>
 478
 479 <pre class="text">
 480   MagickBooleanType UnregisterModule(const ModuleInfo *module_info,
 481     ExceptionInfo *exception)
 482 </pre>
 483
 484 <p>A description of each parameter follows:</p></ol>
 485
 486 <h5>module_info</h5>
 487 <ol><p>the module info.</p></ol>
 488
 489 <h5>exception</h5>
 490 <ol><p>return any errors or warnings in this structure.</p></ol>
 491
 492  </div>
 493 \r
 494 </div>\r
 495 \r
 496 <div id="linkbar">\r
 497  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 498     <span id="linkbar-center">\r
 499       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 500       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
 501     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 502     </span>\r
 503     <span id="linkbar-east">&nbsp;</span>\r
 504   </div>\r
 505   <div class="footer">\r
 506     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
 507     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 508   </div>\r
 509   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 510 </body>\r
 511 </html>\r