Tryag File Manager

//proc/self/root/usr/share/doc/ImageMagick-6.2.8/www/api/module.html

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
  <style type="text/css"></style>
  <title>ImageMagick: MagickCore, C API for ImageMagick: Loadable Modules</title>
  <meta http-equiv="Content-Language" content="en-US"/>
  <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
  <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  <meta name="Generator" content="PHP"/>
  <meta name="Keywords" content="magickcore, c, api, for, imagemagick:, loadable, modules, ImageMagick, PerlMagick, Magick++, Image, Magick"/>
  <meta name="Description" content="ImageMagick (TM) is a free software suite to create, edit and compose bitmap images. It can read, convert and write images in a large variety of formats. Images can be cropped, colors can be changed, various effects can be applied, images can be rotated and combined, and text, lines, polygons, ellipses and Bézier curves can be added to images and stretched and rotated.  ImageMagick is free software: it is delivered with full source code and can be freely used, copied, modified and distributed. Its license is compatible with the GPL. It runs on all major operating systems.  Most of the functionality of ImageMagick can be used interactively from the command line; more often, however, the features are used from programs written in the programming languages Perl, C, C++, Python, PHP, Ruby or Java, for which ready-made ImageMagick interfaces (PerlMagick, Magick++, PythonMagick, MagickWand for PHP, RubyMagick, and JMagick) are available. This makes it possible to modify or create images automatically and dynamically.  ImageMagick supports many image formats (over 90 major formats) including popular formats like TIFF, JPEG, PNG, PDF, PhotoCD, and GIF."/>
  <meta name="Rating" content="GENERAL"/>
  <meta name="Robots" content="INDEX, FOLLOW"/>
  <meta name="Generator" content="ImageMagick Studio LLC"/>
  <meta name="Author" content="ImageMagick Studio LLC"/>
  <meta name="Revisit-after" content="2 DAYS"/>
  <meta name="Resource-type" content="document"/>
  <meta name="Copyright" content="Copyright (c) 1999-2006 ImageMagick Studio LLC"/>
  <meta name="Distribution" content="Global"/>
  <link rel="shortcut icon" href="/../images/wand.ico"  type="image/x-icon"/>
</head>

<tr valign="top" style="height: 100%;">
      <td id="menu" width="1%" height="100%">
      <p><a href="#main">Skip to page contents</a></p>
      <span>[</span>
      <a href="../../index.html">About ImageMagick</a>
      <a href="../../www/command-line-tools.html">Command-line Tools</a>
      <a href="../../www/command-line-processing.html" class="sub">Processing</a>
      <a href="../../www/command-line-options.html" class="sub">Options</a>
      <a href="../../www/api.html">Program Interfaces</a>
      <a href="../../www/magick-wand.html" class="sub">MagickWand</a>
      <a href="../../www/magick-core.html" class="sub">MagickCore</a>
      <a href="../../www/perl-magick.html" class="sub">PerlMagick</a>
      <a href="../../www/architecture.html">Architecture</a>
  <span>]</span><br /><span>[</span>
      <a href="../../www/install-source.html">Install from Source</a>
      <a href="../../www/install-source.html#unix" class="sub">Unix</a>
      <a href="../../www/install-source.html#windows" class="sub">Windows</a>
      <a href="../../www/binary-releases.html">Binary Releases</a>
      <a href="../../www/binary-releases.html#unix" class="sub">Unix</a>
      <a href="../../www/binary-releases.html#windows" class="sub">Windows</a>
      <a href="../../www/resources.html">Resources</a>
  <span>]</span><br /><span>[</span>
      <a href="../../www/download.html">Download</a>
  <span>]</span><br /><span>[</span>
      <a href="../../www/links.html">Links</a>
  <span>]</span><br /><br /><span>[</span>
      <a href="../../www/sponsors.html">Sponsors</a>
  <a href="http://www.desktopexchange.com/" class="sponsor" target="sponsor">Desktop Wallpaper</a>
      <span>]</span>
      </td>

<td id="main" valign="top">
<p class="navigation-index">[ <a href="#DestroyMagickList">DestroyMagickList</a> | <a href="#ExecuteModuleProcess">ExecuteModuleProcess</a> | <a href="#GetModuleInfo">GetModuleInfo</a> | <a href="#GetModuleInfoList">GetModuleInfoList</a> | <a href="#GetModuleList">GetModuleList</a> | <a href="#GetMagickModulePath">GetMagickModulePath</a> | <a href="#ListModuleInfo">ListModuleInfo</a> | <a href="#OpenModule">OpenModule</a> | <a href="#OpenModules">OpenModules</a> | <a href="#RegisterModule">RegisterModule</a> | <a href="#TagToCoderModuleName">TagToCoderModuleName</a> | <a href="#TagToFilterModuleName">TagToFilterModuleName</a> | <a href="#TagToModuleName">TagToModuleName</a> | <a href="#UnregisterModule">UnregisterModule</a> ]</p>

<div style="margin: auto;">
  <h2><a name="DestroyMagickList">DestroyMagickList</a></h2>
</div>

<p>DestroyMagickList() unregisters any previously loaded modules and exits the module loaded environment.</p>

<p>The format of the DestroyMagickList module is:</p>

<pre class="text">
  void DestroyMagickList(void)
</pre>

<div style="margin: auto;">
  <h2><a name="ExecuteModuleProcess">ExecuteModuleProcess</a></h2>
</div>

<p>ExecuteModuleProcess() executes a dynamic modules.</p>

<p>The format of the ExecuteModuleProcess module is:</p>

<pre class="text">
  MagickBooleanType ExecuteModuleProcess(const char *tag,Image **image,
    const int argc,char **argv)
</pre>

<p>A description of each parameter follows:</p>

<h4>tag</h4>
<p>a character string that represents the name of the particular module.</p>

<h4>image</h4>
<p>The image.</p>

<h4>argc</h4>
<p>Specifies a pointer to an integer describing the number of elements in the argument vector.</p>

<h4>argv</h4>
<p>Specifies a pointer to a text array containing the command line arguments.</p>

<div style="margin: auto;">
  <h2><a name="GetModuleInfo">GetModuleInfo</a></h2>
</div>

<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>

<p>The format of the GetModuleInfo module is:</p>

<pre class="text">
  const ModuleInfo *GetModuleInfo(const char *tag,ExceptionInfo *exception)
</pre>

<p>A description of each parameter follows:</p>

<h4>tag</h4>
<p>a character string that represents the image format we are looking for.</p>

<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>

<div style="margin: auto;">
  <h2><a name="GetModuleInfoList">GetModuleInfoList</a></h2>
</div>

<p>GetModuleInfoList() returns any modules that match the specified pattern.</p>

<p>The format of the GetModuleInfoList function is:</p>

<pre class="text">
  const ModuleInfo **GetModuleInfoList(const char *pattern,
    unsigned long *number_modules,ExceptionInfo *exception)
</pre>

<p>A description of each parameter follows:</p>

<h4>pattern</h4>
<p>Specifies a pointer to a text string containing a pattern.</p>

<h4>number_modules</h4>
<p>This integer returns the number of modules in the list.</p>

<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>

<div style="margin: auto;">
  <h2><a name="GetModuleList">GetModuleList</a></h2>
</div>

<p>GetModuleList() returns any image format modules that match the specified pattern.</p>

<p>The format of the GetModuleList function is:</p>

<pre class="text">
  char **GetModuleList(const char *pattern,unsigned long *number_modules,
    ExceptionInfo *exception)
</pre>

<p>A description of each parameter follows:</p>

<h4>pattern</h4>
<p>Specifies a pointer to a text string containing a pattern.</p>

<h4>number_modules</h4>
<p>This integer returns the number of modules in the list.</p>

<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>

<div style="margin: auto;">
  <h2><a name="GetMagickModulePath">GetMagickModulePath</a></h2>
</div>

<p>GetMagickModulePath() finds a module with the specified module type and filename.</p>

<p>The format of the GetMagickModulePath module is:</p>

<pre class="text">
  MagickBooleanType GetMagickModulePath(const char *filename,
    MagickModuleType module_type,char *path,ExceptionInfo *exception)
</pre>

<p>A description of each parameter follows:</p>

<h4>filename</h4>
<p>The module file name.</p>

<h4>module_type</h4>
<p>The module type: MagickCoderModule or MagickFilterModule.</p>

<h4>path</h4>
<p>The path associated with the filename.</p>

<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>

<div style="margin: auto;">
  <h2><a name="ListModuleInfo">ListModuleInfo</a></h2>
</div>

<p>ListModuleInfo() lists the module info to a file.</p>

<p>The format of the ListModuleInfo module is:</p>

<pre class="text">
  MagickBooleanType ListModuleInfo(FILE *file,ExceptionInfo *exception)
</pre>

<p>A description of each parameter follows.</p>

<h4>file</h4>
<p>An pointer to a FILE.</p>

<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>

<div style="margin: auto;">
  <h2><a name="OpenModule">OpenModule</a></h2>
</div>

<p>OpenModule() loads a module, and invokes its registration module.  It returns MagickTrue on success, and MagickFalse if there is an error.</p>

<p>The format of the OpenModule module is:</p>

<pre class="text">
  MagickBooleanType OpenModule(const char *module,ExceptionInfo *exception)
</pre>

<p>A description of each parameter follows:</p>

<h4>module</h4>
<p>a character string that indicates the module to load.</p>

<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>

<div style="margin: auto;">
  <h2><a name="OpenModules">OpenModules</a></h2>
</div>

<p>OpenModules() loads all available modules.</p>

<p>The format of the OpenModules module is:</p>

<pre class="text">
  MagickBooleanType OpenModules(ExceptionInfo *exception)
</pre>

<p>A description of each parameter follows:</p>

<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>

<div style="margin: auto;">
  <h2><a name="RegisterModule">RegisterModule</a></h2>
</div>

<p>RegisterModule() adds an entry to the module list.  It returns a pointer to the registered entry on success.</p>

<p>The format of the RegisterModule module is:</p>

<pre class="text">
  ModuleInfo *RegisterModule(const ModuleInfo *module_info,
    ExceptionInfo *exception)
</pre>

<p>A description of each parameter follows:</p>

<h4>info</h4>
<p>a pointer to the registered entry is returned.</p>

<h4>module_info</h4>
<p>a pointer to the ModuleInfo structure to register.</p>

<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>

<div style="margin: auto;">
  <h2><a name="TagToCoderModuleName">TagToCoderModuleName</a></h2>
</div>

<p>TagToCoderModuleName() munges a module tag and obtains the filename of the corresponding module module.</p>

<p>The format of the TagToCoderModuleName module is:</p>

<pre class="text">
  char *TagToCoderModuleName(const char *tag,char *name)
</pre>

<p>A description of each parameter follows:</p>

<h4>tag</h4>
<p>a character string representing the module tag.</p>

<h4>name</h4>
<p>return the module module name here.</p>

<div style="margin: auto;">
  <h2><a name="TagToFilterModuleName">TagToFilterModuleName</a></h2>
</div>

<p>TagToFilterModuleName() munges a module tag and returns the filename of the corresponding filter module.</p>

<p>The format of the TagToFilterModuleName module is:</p>

<pre class="text">
  void TagToFilterModuleName(const char *tag,char name)
</pre>

<p>A description of each parameter follows:</p>

<h4>tag</h4>
<p>a character string representing the module tag.</p>

<h4>name</h4>
<p>return the filter name here.</p>

<div style="margin: auto;">
  <h2><a name="TagToModuleName">TagToModuleName</a></h2>
</div>

<p>TagToModuleName() munges the module tag name and returns an upper-case tag name as the input string, and a user-provided format.</p>

<p>The format of the TagToModuleName module is:</p>

<pre class="text">
  TagToModuleName(const char *tag,const char *format,char *module)
</pre>

<p>A description of each parameter follows:</p>

<h4>tag</h4>
<p>the module tag.</p>

<h4>format</h4>
<p>a sprintf-compatible format string containing s where the upper-case tag name is to be inserted.</p>

<h4>module</h4>
<p>pointer to a destination buffer for the formatted result.</p>

<div style="margin: auto;">
  <h2><a name="UnregisterModule">UnregisterModule</a></h2>
</div>

<p>UnregisterModule() unloads a module, and invokes its de-registration module. Returns MagickTrue on success, and MagickFalse if there is an error.</p>

<p>The format of the UnregisterModule module is:</p>

<pre class="text">
  MagickBooleanType UnregisterModule(const ModuleInfo *module_info,
    ExceptionInfo *exception)
</pre>

<p>A description of each parameter follows:</p>

<h4>module_info</h4>
<p>The module info.</p>

<h4>exception</h4>
<p>Return any errors or warnings in this structure.</p>

</td>
      <td id="margin" width="1%" height="100%" valign="top" align="right">&nbsp;</td>
    </tr>
  </tbody>
  </table>
  <div id="linkbar">
    <a href="http://redux.imagemagick.org/discussion-server" target="1387482338">Discourse Server</a> |
    <a href="../../www/mailing-list.html">Mailing Lists</a> |
    <a href="http://redux.imagemagick.org/gallery" target="1525957298">Image Gallery</a> |
    <a href="http://redux.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi" target="293741038">ImageMagick Studio</a>
  </div>
  <div>
    <span id="footer-west">&copy; 1999-2006 ImageMagick Studio LLC</span>
  </div>
  <div style="clear: both; margin: 0; width: 100%; "></div>
</body>
</html>