diff --git a/www/api/module.html b/www/api/module.html index b32ef0c..e3f8995 100644 --- a/www/api/module.html +++ b/www/api/module.html
@@ -1,588 +1,521 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" - "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> -<html version="-//W3C//DTD XHTML 1.1//EN" - xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" - xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" - xsi:schemaLocation="http://www.w3.org/1999/xhtml - http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd"> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> +<html lang="en"> <head> - <meta http-equiv="content-type" content="text/html; charset=UTF-8"/> - <meta name=viewport content="width=device-width, initial-scale=0.3333334"> - <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4"/> + <meta charset="utf-8"> + <meta http-equiv="X-UA-Compatible" content="IE=edge"> + <meta name="viewport" content="width=device-width, initial-scale=1"> <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="[email protected]"/> - <meta name="application-name" content="ImageMagick"/> - <meta name="description" content="A collection of tools and libraries to read, write, and manipulate an image in any of the more popular image formats."/> - <meta name="application-url" content="http://www.imagemagick.org"/> - <meta name="generator" content="PHP"/> - <meta name="keywords" content="magickcore, c, api, for, imagemagick:, loadable, modules, convert, edit, compose, image, pixel"/> - <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-2012 ImageMagick Studio LLC"/> - <meta name="distribution" content="Global"/> - <link rel="icon" href="../../../../images/wand.png"/> - <link rel="shortcut icon" href="../../../../images/wand.ico" type="images/x-icon"/> - <link rel="canonical" href="http://www.imagemagick.org" /> - <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/> - - <!-- Add jQuery library --> - <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/2.1.0/jquery.min.js"></script> - - <!-- Add mousewheel plugin (this is optional) --> - <script type="text/javascript" src="http://www.imagemagick.org/fancybox/lib/jquery.mousewheel-3.0.6.pack.js"></script> - - <!-- Add fancyBox --> - <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/jquery.fancybox.css?v=2.1.5" type="text/css" media="screen" /> - <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/jquery.fancybox.pack.js?v=2.1.5"></script> - - <!-- Optionally add helpers - button, thumbnail and/or media --> - <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.css?v=1.0.5" type="text/css" media="screen" /> - <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.js?v=1.0.5"></script> - <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-media.js?v=1.0.6"></script> - - <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.css?v=1.0.7" type="text/css" media="screen" /> - <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.js?v=1.0.7"></script> - - <script type="text/javascript"> - $(document).ready(function() { - $(".fancybox").fancybox(); - }); - </script> - - <!-- ImageMagick style --> - <style type="text/css" media="all"> - @import url("../../../../www/magick.css"); - </style> + <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="[email protected]"> + <meta name="application-name" content="ImageMagick"> + <meta name="description" content="ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves."> + <meta name="application-url" content="http://www.imagemagick.org"> + <meta name="generator" content="PHP"> + <meta name="keywords" content="magickcore, c, api, for, imagemagick:, loadable, modules, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert"> + <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-2012 ImageMagick Studio LLC"> + <meta name="distribution" content="Global"> + <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1"> + <link rel="icon" href="../../images/wand.png"> + <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"> + <link rel="stylesheet" href="css/bootstrap.min.css"> + <link rel="stylesheet" href="css/magick.css"> </head> -<body id="www-imagemagick-org"> - -<script type="text/javascript"> - (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){ - (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o), - m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m) - })(window,document,'offline-script','//www.google-analytics.com/analytics.js','ga'); - - ga('create', 'UA-40133312-1', 'imagemagick.org'); - ga('send', 'pageview'); -</script> - -<div class="titlebar"> -<div style="margin: 17px auto; float: left;"> - <script type="text/javascript"> - <!-- - google_ad_client = "pub-3129977114552745"; - google_ad_slot = "5439289906"; - google_ad_width = 728; - google_ad_height = 90; - //--> - </script> - <script type="text/javascript" - src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> - </script> -</div> -<a href="../../../../discourse-server"> - <img src="../../../../images/logo.jpg" - alt="ImageMagick Logo" width="123" height="118" - style="width: 123px; height: 118px; border: 0px; float: right;" /></a> -<a href="http://www.imagemagick.org/ImageMagick-7.0.0/index.html"> - <img src="../../../../images/sprite.jpg" - alt="ImageMagick Sprite" width="114" height="118" - style="width: 114px; height: 118px; border: 0px; float: right;" /></a> -</div> - -<div class="westbar"> - -<div class="menu"> - <a title="About ImageMagick" href="http://www.imagemagick.org/ImageMagick-7.0.0/index.html">About ImageMagick</a> -</div> -<div class="menu"> - <a title="Binary Releases" href="../../../../www/binary-releases.html">Binary Releases</a> -</div> -<div class="sub"> - <a title="Binary Release: Unix" href="../../../../www/binary-releases.html#unix">Unix</a> -</div> -<div class="sub"> - <a title="Binary Release: MacOS X" href="../../../../www/binary-releases.html#macosx">Mac OS X</a> -</div> -<div class="sub"> - <a title="Binary Release: iOS" href="../../../../www/binary-releases.html#iOS">iOS</a> -</div> -<div class="sub"> - <a title="Binary Release: Windows" href="../../../../www/binary-releases.html#windows">Windows</a> -</div> -<div class="sep"></div> -<div class="menu"> - <a title="Command-line Tools" href="../../../../www/command-line-tools.html">Command-line Tools</a> -</div> -<div class="sub"> - <a title="Command-line Tools: Processing" href="../../../../www/command-line-processing.html">Processing</a> -</div> -<div class="sub"> - <a title="Command-line Tools: Options" href="../../../../www/command-line-options.html">Options</a> -</div> -<div class="sub"> - <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a> -</div> -<div class="menu"> - <a title="Program Interfaces" href="../../../../www/api.html">Program Interfaces</a> -</div> -<div class="sub"> - <a title="Program Interface: MagickWand" href="../../../../www/magick-wand.html">MagickWand</a> -</div> -<div class="sub"> - <a title="Program Interface: MagickCore" href="../../../../www/magick-core.html">MagickCore</a> -</div> -<div class="sub"> - <a title="Program Interface: PerlMagick" href="../../../../www/perl-magick.html">PerlMagick</a> -</div> -<div class="sub"> - <a title="Program Interface: Magick++" href="../../../../www/magick++.html">Magick++</a> -</div> -<div class="sep"></div> -<div class="menu"> - <a title="Install from Source" href="../../../../www/install-source.html">Install from Source</a> -</div> -<div class="sub"> - <a title="Install from Source: Unix" href="../../../../www/install-source.html#unix">Unix</a> -</div> -<div class="sub"> - <a title="Install from Source: Windows" href="../../../../www/install-source.html#windows">Windows</a> - </div> -<div class="menu"> - <a title="Resources" href="../../../../www/resources.html">Resources</a> -</div> -<div class="menu"> - <a title="Architecture" href="../../../../www/architecture.html">Architecture</a> -</div> -<div class="menu"> - <a title="Download" href="../../../../www/download.html">Download</a> -</div> -<div class="sep"></div> -<div class="menu"> - <a title="Search" href="http://www.imagemagick.org/http://www.imagemagick.org/script/search.php">Search</a> -</div> -<div class="sep"></div> -<div class="menu"> - <a title="Site Map" href="../../../../www/sitemap.html">Site Map</a> -</div> -<div class="sub"> - <a title="Site Map: Links" href="../../../../www/links.html">Links</a> -</div> -<div class="sep"></div> -</div> - -<div class="eastbar"> - <script type="text/javascript"> - /* <![CDATA[ */ - window.___gcfg = { - lang: 'en-US' - }; - - (function() { - var po = document.createElement('offline-script'); - po.type = 'text/javascript'; - po.async = true; - po.src = 'https://apis.google.com/js/plusone.js'; - var script = document.getElementsByTagName('offline-script')[0]; - script.parentNode.insertBefore(po, script); - })(); - var gplusone = document.getElementById("gplusone"); - gplusone.setAttribute("data-size","medium"); - gplusone.setAttribute("data-count","true"); - /* ]]> */ - </script> - <script type="text/javascript"> - /* <![CDATA[ */ - (function() { - var po = document.createElement('offline-script'), t = document.getElementsByTagName('offline-script')[0]; - po.type = 'text/javascript'; - po.async = true; - po.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto'; - var script = document.getElementsByTagName('offline-script')[0]; - script.parentNode.insertBefore(po, script); - })(); - /* ]]> */ - </script> - <div> <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="http://www.imagemagick.org/"></a></div> - <noscript> - <a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank"> - <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" width="93" height="20" border="0" /></a> - </noscript> - <div class="g-plusone" data-size="standard" data-count="true"></div> -</div> - +<body> <div class="main"> +<div class="magick-masthead"> + <div class="container"> + <script type="text/javascript"> + <!-- + google_ad_client = "pub-3129977114552745"; + google_ad_slot = "5439289906"; + google_ad_width = 728; + google_ad_height = 90; + //--> + </script> + <center><script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> + </script></center> + <nav class="magick-nav"> + <a class="magick-nav-item " href="../../index.html">Home</a> + <a class="magick-nav-item " href="../../www/binary-releases.html">Downloads</a> + <a class="magick-nav-item " href="../../www/command-line-tools.html">Tools</a> + <a class="magick-nav-item " href="../../www/command-line-options.html">Options</a> + <a class="magick-nav-item " href="../../www/api.html">Development</a> + <a class="magick-nav-item" href="http://www.imagemagick.org/discourse-server/">Community</a> + <a class="magick-nav-item navbar-right " href="http://www.imagemagick.org/script/search.php">Search</a> + </nav> + </div> +</div> +<div class="container"> +<p class="text-center"><a href="module.html#AcquireModuleInfo">AcquireModuleInfo</a> • <a href="module.html#DestroyModuleList">DestroyModuleList</a> • <a href="module.html#GetModuleInfo">GetModuleInfo</a> • <a href="module.html#GetModuleInfoList">GetModuleInfoList</a> • <a href="module.html#GetModuleList">GetModuleList</a> • <a href="module.html#GetMagickModulePath">GetMagickModulePath</a> • <a href="module.html#IsModuleTreeInstantiated">IsModuleTreeInstantiated</a> • <a href="module.html#InvokeDynamicImageFilter">InvokeDynamicImageFilter</a> • <a href="module.html#ListModuleInfo">ListModuleInfo</a> • <a href="module.html#OpenModule">OpenModule</a> • <a href="module.html#OpenModules">OpenModules</a> • <a href="module.html#RegisterModule">RegisterModule</a> • <a href="module.html#TagToCoderModuleName">TagToCoderModuleName</a> • <a href="module.html#TagToFilterModuleName">TagToFilterModuleName</a> • <a href="module.html#TagToModuleName">TagToModuleName</a> • <a href="module.html#UnregisterModule">UnregisterModule</a></p> -<h1>Module module Methods</h1> -<p class="navigation-index">[<a href="module.html#AcquireModuleInfo">AcquireModuleInfo</a> • <a href="module.html#DestroyModuleList">DestroyModuleList</a> • <a href="module.html#GetModuleInfo">GetModuleInfo</a> • <a href="module.html#GetModuleInfoList">GetModuleInfoList</a> • <a href="module.html#GetModuleList">GetModuleList</a> • <a href="module.html#GetMagickModulePath">GetMagickModulePath</a> • <a href="module.html#InitializeModuleList">InitializeModuleList</a> • <a href="module.html#InvokeDynamicImageFilter">InvokeDynamicImageFilter</a> • <a href="module.html#ListModuleInfo">ListModuleInfo</a> • <a href="module.html#OpenModule">OpenModule</a> • <a href="module.html#OpenModules">OpenModules</a> • <a href="module.html#RegisterModule">RegisterModule</a> • <a href="module.html#TagToCoderModuleName">TagToCoderModuleName</a> • <a href="module.html#TagToFilterModuleName">TagToFilterModuleName</a> • <a href="module.html#TagToModuleName">TagToModuleName</a> • <a href="module.html#UnregisterModule">UnregisterModule</a>]</p> - +<div class="magick-header"> <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="AcquireModuleInfo">AcquireModuleInfo</a></h2> -<div class="doc-section"> <p>AcquireModuleInfo() allocates the ModuleInfo structure.</p> <p>The format of the AcquireModuleInfo method is:</p> -<pre class="code"> - ModuleInfo *AcquireModuleInfo(const char *path,const char *tag) +<pre class="text"> +ModuleInfo *AcquireModuleInfo(const char *path,const char *tag) </pre> <p>A description of each parameter follows:</p> -<h5>path</h5> -<p>the path associated with the tag.</p> +<dd> +</dd> -<h5>tag</h5> -<p>a character string that represents the image format we are looking for.</p> +<dd> </dd> +<dl class="dl-horizontal"> +<dt>path</dt> +<dd>the path associated with the tag. </dd> - </div> +<dd> </dd> +<dt>tag</dt> +<dd>a character string that represents the image format we are looking for. </dd> + +<dd> </dd> +</dl> <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="DestroyModuleList">DestroyModuleList</a></h2> -<div class="doc-section"> <p>DestroyModuleList() unregisters any previously loaded modules and exits the module loaded environment.</p> <p>The format of the DestroyModuleList module is:</p> <pre class="text"> - void DestroyModuleList(void) +void DestroyModuleList(void) </pre> - </div> <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="GetModuleInfo">GetModuleInfo</a></h2> -<div class="doc-section"> <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"> - ModuleInfo *GetModuleInfo(const char *tag,ExceptionInfo *exception) +ModuleInfo *GetModuleInfo(const char *tag,ExceptionInfo *exception) </pre> <p>A description of each parameter follows:</p> -<h5>tag</h5> -<p>a character string that represents the image format we are looking for.</p> +<dd> +</dd> -<h5>exception</h5> -<p>return any errors or warnings in this structure.</p> +<dd> </dd> +<dl class="dl-horizontal"> +<dt>tag</dt> +<dd>a character string that represents the image format we are looking for. </dd> - </div> +<dd> </dd> +<dt>exception</dt> +<dd>return any errors or warnings in this structure. </dd> + +<dd> </dd> +</dl> <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="GetModuleInfoList">GetModuleInfoList</a></h2> -<div class="doc-section"> <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, - size_t *number_modules,ExceptionInfo *exception) +const ModuleInfo **GetModuleInfoList(const char *pattern, + size_t *number_modules,ExceptionInfo *exception) </pre> <p>A description of each parameter follows:</p> -<h5>pattern</h5> -<p>Specifies a pointer to a text string containing a pattern.</p> +<dd> +</dd> -<h5>number_modules</h5> -<p>This integer returns the number of modules in the list.</p> +<dd> </dd> +<dl class="dl-horizontal"> +<dt>pattern</dt> +<dd>Specifies a pointer to a text string containing a pattern. </dd> -<h5>exception</h5> -<p>return any errors or warnings in this structure.</p> +<dd> </dd> +<dt>number_modules</dt> +<dd> This integer returns the number of modules in the list. </dd> - </div> +<dd> </dd> +<dt>exception</dt> +<dd>return any errors or warnings in this structure. </dd> + +<dd> </dd> +</dl> <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="GetModuleList">GetModuleList</a></h2> -<div class="doc-section"> <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,const MagickModuleType type, - size_t *number_modules,ExceptionInfo *exception) +char **GetModuleList(const char *pattern,const MagickModuleType type, + size_t *number_modules,ExceptionInfo *exception) </pre> <p>A description of each parameter follows:</p> -<h5>pattern</h5> -<p>Specifies a pointer to a text string containing a pattern.</p> +<dd> +</dd> -<h5>type</h5> -<p>choose from MagickImageCoderModule or MagickImageFilterModule.</p> +<dd> </dd> +<dl class="dl-horizontal"> +<dt>pattern</dt> +<dd>Specifies a pointer to a text string containing a pattern. </dd> -<h5>number_modules</h5> -<p>This integer returns the number of modules in the list.</p> +<dd> </dd> +<dt>type</dt> +<dd>choose from MagickImageCoderModule or MagickImageFilterModule. </dd> -<h5>exception</h5> -<p>return any errors or warnings in this structure.</p> +<dd> </dd> +<dt>number_modules</dt> +<dd> This integer returns the number of modules in the list. </dd> - </div> +<dd> </dd> +<dt>exception</dt> +<dd>return any errors or warnings in this structure. </dd> + +<dd> </dd> +</dl> <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="GetMagickModulePath">GetMagickModulePath</a></h2> -<div class="doc-section"> <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) +MagickBooleanType GetMagickModulePath(const char *filename, + MagickModuleType module_type,char *path,ExceptionInfo *exception) </pre> <p>A description of each parameter follows:</p> -<h5>filename</h5> -<p>the module file name.</p> +<dd> +</dd> -<h5>module_type</h5> -<p>the module type: MagickImageCoderModule or MagickImageFilterModule.</p> +<dd> </dd> +<dl class="dl-horizontal"> +<dt>filename</dt> +<dd>the module file name. </dd> -<h5>path</h5> -<p>the path associated with the filename.</p> +<dd> </dd> +<dt>module_type</dt> +<dd>the module type: MagickImageCoderModule or MagickImageFilterModule. </dd> -<h5>exception</h5> -<p>return any errors or warnings in this structure.</p> +<dd> </dd> +<dt>path</dt> +<dd>the path associated with the filename. </dd> - </div> -<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="InitializeModuleList">InitializeModuleList</a></h2> -<div class="doc-section"> +<dd> </dd> +<dt>exception</dt> +<dd>return any errors or warnings in this structure. </dd> -<p>InitializeModuleList() initializes the module loader.</p> +<dd> </dd> +</dl> +<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="IsModuleTreeInstantiated">IsModuleTreeInstantiated</a></h2> -<p>The format of the InitializeModuleList() method is:</p> +<p>IsModuleTreeInstantiated() determines if the module tree is instantiated. If not, it instantiates the tree and returns it.</p> -<pre class="code"> - InitializeModuleList(Exceptioninfo *exception) +<p>The format of the IsModuleTreeInstantiated() method is:</p> + +<pre class="text"> +IsModuleTreeInstantiated(Exceptioninfo *exception) </pre> <p>A description of each parameter follows.</p> -<h5>exception</h5> +<dt>exception</dt> <p>return any errors or warnings in this structure.</p> - </div> <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="InvokeDynamicImageFilter">InvokeDynamicImageFilter</a></h2> -<div class="doc-section"> <p>InvokeDynamicImageFilter() invokes a dynamic image filter.</p> <p>The format of the InvokeDynamicImageFilter module is:</p> <pre class="text"> - MagickBooleanType InvokeDynamicImageFilter(const char *tag,Image **image, - const int argc,const char **argv,ExceptionInfo *exception) +MagickBooleanType InvokeDynamicImageFilter(const char *tag,Image **image, + const int argc,const char **argv,ExceptionInfo *exception) </pre> <p>A description of each parameter follows:</p> -<h5>tag</h5> -<p>a character string that represents the name of the particular module.</p> +<dd> +</dd> -<h5>image</h5> -<p>the image.</p> +<dd> </dd> +<dl class="dl-horizontal"> +<dt>tag</dt> +<dd>a character string that represents the name of the particular module. </dd> -<h5>argc</h5> -<p>a pointer to an integer describing the number of elements in the argument vector.</p> +<dd> </dd> +<dt>image</dt> +<dd>the image. </dd> -<h5>argv</h5> -<p>a pointer to a text array containing the command line arguments.</p> +<dd> </dd> +<dt>argc</dt> +<dd>a pointer to an integer describing the number of elements in the argument vector. </dd> -<h5>exception</h5> -<p>return any errors or warnings in this structure.</p> +<dd> </dd> +<dt>argv</dt> +<dd>a pointer to a text array containing the command line arguments. </dd> - </div> +<dd> </dd> +<dt>exception</dt> +<dd>return any errors or warnings in this structure. </dd> + +<dd> </dd> +</dl> <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="ListModuleInfo">ListModuleInfo</a></h2> -<div class="doc-section"> <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) +MagickBooleanType ListModuleInfo(FILE *file,ExceptionInfo *exception) </pre> <p>A description of each parameter follows.</p> -<h5>file</h5> +<dt>file</dt> <p>An pointer to a FILE.</p> -<h5>exception</h5> +<dt>exception</dt> <p>return any errors or warnings in this structure.</p> - </div> <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="OpenModule">OpenModule</a></h2> -<div class="doc-section"> <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) +MagickBooleanType OpenModule(const char *module,ExceptionInfo *exception) </pre> <p>A description of each parameter follows:</p> -<h5>module</h5> -<p>a character string that indicates the module to load.</p> +<dd> +</dd> -<h5>exception</h5> -<p>return any errors or warnings in this structure.</p> +<dd> </dd> +<dl class="dl-horizontal"> +<dt>module</dt> +<dd>a character string that indicates the module to load. </dd> - </div> +<dd> </dd> +<dt>exception</dt> +<dd>return any errors or warnings in this structure. </dd> + +<dd> </dd> +</dl> <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="OpenModules">OpenModules</a></h2> -<div class="doc-section"> <p>OpenModules() loads all available modules.</p> <p>The format of the OpenModules module is:</p> <pre class="text"> - MagickBooleanType OpenModules(ExceptionInfo *exception) +MagickBooleanType OpenModules(ExceptionInfo *exception) </pre> <p>A description of each parameter follows:</p> -<h5>exception</h5> -<p>return any errors or warnings in this structure.</p> +<dd> +</dd> - </div> +<dd> </dd> +<dl class="dl-horizontal"> +<dt>exception</dt> +<dd>return any errors or warnings in this structure. </dd> + +<dd> </dd> +</dl> <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="RegisterModule">RegisterModule</a></h2> -<div class="doc-section"> <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) +ModuleInfo *RegisterModule(const ModuleInfo *module_info, + ExceptionInfo *exception) </pre> <p>A description of each parameter follows:</p> -<h5>info</h5> -<p>a pointer to the registered entry is returned.</p> +<dd> +</dd> -<h5>module_info</h5> -<p>a pointer to the ModuleInfo structure to register.</p> +<dd> </dd> +<dl class="dl-horizontal"> +<dt>info</dt> +<dd>a pointer to the registered entry is returned. </dd> -<h5>exception</h5> -<p>return any errors or warnings in this structure.</p> +<dd> </dd> +<dt>module_info</dt> +<dd>a pointer to the ModuleInfo structure to register. </dd> - </div> +<dd> </dd> +<dt>exception</dt> +<dd>return any errors or warnings in this structure. </dd> + +<dd> </dd> +</dl> <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="TagToCoderModuleName">TagToCoderModuleName</a></h2> -<div class="doc-section"> <p>TagToCoderModuleName() munges a module tag and obtains the filename of the corresponding module.</p> <p>The format of the TagToCoderModuleName module is:</p> <pre class="text"> - char *TagToCoderModuleName(const char *tag,char *name) +char *TagToCoderModuleName(const char *tag,char *name) </pre> <p>A description of each parameter follows:</p> -<h5>tag</h5> -<p>a character string representing the module tag.</p> +<dd> +</dd> -<h5>name</h5> -<p>return the module name here.</p> +<dd> </dd> +<dl class="dl-horizontal"> +<dt>tag</dt> +<dd>a character string representing the module tag. </dd> - </div> +<dd> </dd> +<dt>name</dt> +<dd>return the module name here. </dd> + +<dd> </dd> +</dl> <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="TagToFilterModuleName">TagToFilterModuleName</a></h2> -<div class="doc-section"> <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) +void TagToFilterModuleName(const char *tag,char name) </pre> <p>A description of each parameter follows:</p> -<h5>tag</h5> -<p>a character string representing the module tag.</p> +<dd> +</dd> -<h5>name</h5> -<p>return the filter name here.</p> +<dd> </dd> +<dl class="dl-horizontal"> +<dt>tag</dt> +<dd>a character string representing the module tag. </dd> - </div> +<dd> </dd> +<dt>name</dt> +<dd>return the filter name here. </dd> + +<dd> </dd> +</dl> <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="TagToModuleName">TagToModuleName</a></h2> -<div class="doc-section"> <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) +TagToModuleName(const char *tag,const char *format,char *module) </pre> <p>A description of each parameter follows:</p> -<h5>tag</h5> -<p>the module tag.</p> +<dd> +</dd> -<h5>format</h5> -<p>a sprintf-compatible format string containing s where the upper-case tag name is to be inserted.</p> +<dd> </dd> +<dl class="dl-horizontal"> +<dt>tag</dt> +<dd>the module tag. </dd> -<h5>module</h5> -<p>pointer to a destination buffer for the formatted result.</p> +<dd> </dd> +<dt>format</dt> +<dd>a sprintf-compatible format string containing s where the upper-case tag name is to be inserted. </dd> - </div> +<dd> </dd> +<dt>module</dt> +<dd>pointer to a destination buffer for the formatted result. </dd> + +<dd> </dd> +</dl> <h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="UnregisterModule">UnregisterModule</a></h2> -<div class="doc-section"> <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) +MagickBooleanType UnregisterModule(const ModuleInfo *module_info, + ExceptionInfo *exception) </pre> <p>A description of each parameter follows:</p> -<h5>module_info</h5> -<p>the module info.</p> +<dd> +</dd> -<h5>exception</h5> -<p>return any errors or warnings in this structure.</p> +<dd> </dd> +<dl class="dl-horizontal"> +<dt>module_info</dt> +<dd>the module info. </dd> - </div> +<dd> </dd> +<dt>exception</dt> +<dd>return any errors or warnings in this structure. </dd> +<dd> </dd> +</dl> </div> + <footer class="magick-footer"> + <div class="magick-nav-item navbar-left"> + <a href="../../www/support.html">Donations</a> + </div> + <div class="magick-nav-item navbar-right"> + <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="../../index.html"></a> + <noscript> + <a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank"> + <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" border="0"></a> + </noscript> + </div> + <p><a href="../../www/sitemap.html">Sitemap</a> • + <a href="../../www/links.html">Related</a> • + <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Image Studio</a> • + <a href="http://jqmagick.imagemagick.org/">JqMagick</a> • + <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> +</p> + <p><a href="module.html#">Back to top</a> • + <a href="../../www/contact.html">Contact Us</a></p> + </footer> +</div><!-- /.container --> -<div id="linkbar"> - <span id="linkbar-west"> </span> - - <span id="linkbar-center"> - <a href="../../../../discourse-server">Discourse Server</a> • - <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> • - <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a> • - <a href="http://jqmagick.imagemagick.org/">JqMagick</a> - </span> - <span id="linkbar-east"> </span> + <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script> + <script src="../../js/bootstrap.min.js"></script> + <script type="text/javascript"> + /* */ + (function() { + var s = document.createElement('offline-script'), t = document.getElementsByTagName('offline-script')[0]; + s.type = 'text/javascript'; + s.async = true; + s.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto'; + t.parentNode.insertBefore(s, t); + })(); + /* */ + </script> </div> -<div class="footer"> - <span id="footer-west">© 1999-2014 ImageMagick Studio LLC</span> - <span id="footer-east"> <a href="../../../../www/contact.html">Contact the Wizards</a></span> -</div> -<div style="clear: both; margin: 0; width: 100%; "></div> </body> -</html> +</html><!-- Magick Cache 4th May 2015 17:59 -->