Google Git
Sign in
android / platform / external / ImageMagick / abed55c7b1bd0cb1596c1c3bc8581e3eaddb0a5f / . / www / api / module.html
blob: 4cb9669297df3b0da8589026ec471f536d61f8b1 [file] [log] [blame]
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2<html lang="en">
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]3<head>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]4 <meta charset="utf-8">
5 <meta http-equiv="X-UA-Compatible" content="IE=edge">
6 <meta name="viewport" content="width=device-width, initial-scale=1">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]7 <title>ImageMagick: MagickCore, C API for ImageMagick: Loadable Modules</title>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]8 <meta http-equiv="content-language" content="en-US">
9 <meta http-equiv="content-type" content="text/html; charset=utf-8">
10 <meta http-equiv="reply-to" content="magick-users@imagemagick.org">
11 <meta name="application-name" content="ImageMagick">
12 <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.">
13 <meta name="application-url" content="http://www.imagemagick.org">
14 <meta name="generator" content="PHP">
15 <meta name="keywords" content="magickcore, c, api, for, imagemagick:, loadable, modules, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert">
16 <meta name="rating" content="GENERAL">
17 <meta name="robots" content="INDEX, FOLLOW">
18 <meta name="generator" content="ImageMagick Studio LLC">
19 <meta name="author" content="ImageMagick Studio LLC">
20 <meta name="revisit-after" content="2 DAYS">
21 <meta name="resource-type" content="document">
22 <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC">
23 <meta name="distribution" content="Global">
24 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1">
25 <link rel="icon" href="../../images/wand.png">
26 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon">
cristy85893d32015-05-06 13:44:09 +0000[diff] [blame]27 <link rel="stylesheet" href="../../css/bootstrap.min.css">
28 <link rel="stylesheet" href="../../css/magick.css">
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]29</head>
30
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]31<body>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]32<div class="main">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]33<div class="magick-masthead">
34 <div class="container">
35 <script type="text/javascript">
36 <!--
37 google_ad_client = "pub-3129977114552745";
38 google_ad_slot = "5439289906";
39 google_ad_width = 728;
40 google_ad_height = 90;
41 //-->
42 </script>
43 <center><script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
44 </script></center>
45 <nav class="magick-nav">
46 <a class="magick-nav-item " href="../../index.html">Home</a>
47 <a class="magick-nav-item " href="../../www/binary-releases.html">Downloads</a>
48 <a class="magick-nav-item " href="../../www/command-line-tools.html">Tools</a>
49 <a class="magick-nav-item " href="../../www/command-line-options.html">Options</a>
50 <a class="magick-nav-item " href="../../www/api.html">Development</a>
51 <a class="magick-nav-item" href="http://www.imagemagick.org/discourse-server/">Community</a>
cristyabed55c2015-05-06 17:07:00 +0000[diff] [blame^]52 <a class="magick-nav-item navbar-right " href="http://www.imagemagick.org/script/search.php">Search</a>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]53 </nav>
54 </div>
55</div>
56<div class="container">
57<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>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]58
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]59<div class="magick-header">
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]60<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="AcquireModuleInfo">AcquireModuleInfo</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]61
62<p>AcquireModuleInfo() allocates the ModuleInfo structure.</p>
63
64<p>The format of the AcquireModuleInfo method is:</p>
65
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]66<pre class="text">
67ModuleInfo *AcquireModuleInfo(const char *path,const char *tag)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]68</pre>
69
70<p>A description of each parameter follows:</p>
71
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]72<dd>
73</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]74
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]75<dd> </dd>
76<dl class="dl-horizontal">
77<dt>path</dt>
78<dd>the path associated with the tag. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]79
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]80<dd> </dd>
81<dt>tag</dt>
82<dd>a character string that represents the image format we are looking for. </dd>
83
84<dd> </dd>
85</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]86<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="DestroyModuleList">DestroyModuleList</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]87
88<p>DestroyModuleList() unregisters any previously loaded modules and exits the module loaded environment.</p>
89
90<p>The format of the DestroyModuleList module is:</p>
91
92<pre class="text">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]93void DestroyModuleList(void)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]94</pre>
95
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]96<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="GetModuleInfo">GetModuleInfo</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]97
98<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>
99
100<p>The format of the GetModuleInfo module is:</p>
101
102<pre class="text">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]103ModuleInfo *GetModuleInfo(const char *tag,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]104</pre>
105
106<p>A description of each parameter follows:</p>
107
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]108<dd>
109</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]110
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]111<dd> </dd>
112<dl class="dl-horizontal">
113<dt>tag</dt>
114<dd>a character string that represents the image format we are looking for. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]115
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]116<dd> </dd>
117<dt>exception</dt>
118<dd>return any errors or warnings in this structure. </dd>
119
120<dd> </dd>
121</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]122<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="GetModuleInfoList">GetModuleInfoList</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]123
124<p>GetModuleInfoList() returns any modules that match the specified pattern.</p>
125
126<p>The format of the GetModuleInfoList function is:</p>
127
128<pre class="text">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]129const ModuleInfo **GetModuleInfoList(const char *pattern,
130 size_t *number_modules,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]131</pre>
132
133<p>A description of each parameter follows:</p>
134
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]135<dd>
136</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]137
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]138<dd> </dd>
139<dl class="dl-horizontal">
140<dt>pattern</dt>
141<dd>Specifies a pointer to a text string containing a pattern. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]142
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]143<dd> </dd>
144<dt>number_modules</dt>
145<dd> This integer returns the number of modules in the list. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]146
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]147<dd> </dd>
148<dt>exception</dt>
149<dd>return any errors or warnings in this structure. </dd>
150
151<dd> </dd>
152</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]153<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="GetModuleList">GetModuleList</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]154
155<p>GetModuleList() returns any image format modules that match the specified pattern.</p>
156
157<p>The format of the GetModuleList function is:</p>
158
159<pre class="text">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]160char **GetModuleList(const char *pattern,const MagickModuleType type,
161 size_t *number_modules,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]162</pre>
163
164<p>A description of each parameter follows:</p>
165
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]166<dd>
167</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]168
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]169<dd> </dd>
170<dl class="dl-horizontal">
171<dt>pattern</dt>
172<dd>Specifies a pointer to a text string containing a pattern. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]173
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]174<dd> </dd>
175<dt>type</dt>
176<dd>choose from MagickImageCoderModule or MagickImageFilterModule. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]177
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]178<dd> </dd>
179<dt>number_modules</dt>
180<dd> This integer returns the number of modules in the list. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]181
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]182<dd> </dd>
183<dt>exception</dt>
184<dd>return any errors or warnings in this structure. </dd>
185
186<dd> </dd>
187</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]188<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="GetMagickModulePath">GetMagickModulePath</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]189
190<p>GetMagickModulePath() finds a module with the specified module type and filename.</p>
191
192<p>The format of the GetMagickModulePath module is:</p>
193
194<pre class="text">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]195MagickBooleanType GetMagickModulePath(const char *filename,
196 MagickModuleType module_type,char *path,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]197</pre>
198
199<p>A description of each parameter follows:</p>
200
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]201<dd>
202</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]203
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]204<dd> </dd>
205<dl class="dl-horizontal">
206<dt>filename</dt>
207<dd>the module file name. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]208
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]209<dd> </dd>
210<dt>module_type</dt>
211<dd>the module type: MagickImageCoderModule or MagickImageFilterModule. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]212
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]213<dd> </dd>
214<dt>path</dt>
215<dd>the path associated with the filename. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]216
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]217<dd> </dd>
218<dt>exception</dt>
219<dd>return any errors or warnings in this structure. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]220
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]221<dd> </dd>
222</dl>
223<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="IsModuleTreeInstantiated">IsModuleTreeInstantiated</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]224
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]225<p>IsModuleTreeInstantiated() determines if the module tree is instantiated. If not, it instantiates the tree and returns it.</p>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]226
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]227<p>The format of the IsModuleTreeInstantiated() method is:</p>
228
229<pre class="text">
230IsModuleTreeInstantiated(Exceptioninfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]231</pre>
232
233<p>A description of each parameter follows.</p>
234
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]235<dt>exception</dt>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]236<p>return any errors or warnings in this structure.</p>
237
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]238<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="InvokeDynamicImageFilter">InvokeDynamicImageFilter</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]239
240<p>InvokeDynamicImageFilter() invokes a dynamic image filter.</p>
241
242<p>The format of the InvokeDynamicImageFilter module is:</p>
243
244<pre class="text">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]245MagickBooleanType InvokeDynamicImageFilter(const char *tag,Image **image,
246 const int argc,const char **argv,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]247</pre>
248
249<p>A description of each parameter follows:</p>
250
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]251<dd>
252</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]253
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]254<dd> </dd>
255<dl class="dl-horizontal">
256<dt>tag</dt>
257<dd>a character string that represents the name of the particular module. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]258
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]259<dd> </dd>
260<dt>image</dt>
261<dd>the image. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]262
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]263<dd> </dd>
264<dt>argc</dt>
265<dd>a pointer to an integer describing the number of elements in the argument vector. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]266
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]267<dd> </dd>
268<dt>argv</dt>
269<dd>a pointer to a text array containing the command line arguments. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]270
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]271<dd> </dd>
272<dt>exception</dt>
273<dd>return any errors or warnings in this structure. </dd>
274
275<dd> </dd>
276</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]277<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="ListModuleInfo">ListModuleInfo</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]278
279<p>ListModuleInfo() lists the module info to a file.</p>
280
281<p>The format of the ListModuleInfo module is:</p>
282
283<pre class="text">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]284MagickBooleanType ListModuleInfo(FILE *file,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]285</pre>
286
287<p>A description of each parameter follows.</p>
288
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]289<dt>file</dt>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]290<p>An pointer to a FILE.</p>
291
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]292<dt>exception</dt>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]293<p>return any errors or warnings in this structure.</p>
294
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]295<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="OpenModule">OpenModule</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]296
297<p>OpenModule() loads a module, and invokes its registration module. It returns MagickTrue on success, and MagickFalse if there is an error.</p>
298
299<p>The format of the OpenModule module is:</p>
300
301<pre class="text">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]302MagickBooleanType OpenModule(const char *module,ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]303</pre>
304
305<p>A description of each parameter follows:</p>
306
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]307<dd>
308</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]309
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]310<dd> </dd>
311<dl class="dl-horizontal">
312<dt>module</dt>
313<dd>a character string that indicates the module to load. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]314
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]315<dd> </dd>
316<dt>exception</dt>
317<dd>return any errors or warnings in this structure. </dd>
318
319<dd> </dd>
320</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]321<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="OpenModules">OpenModules</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]322
323<p>OpenModules() loads all available modules.</p>
324
325<p>The format of the OpenModules module is:</p>
326
327<pre class="text">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]328MagickBooleanType OpenModules(ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]329</pre>
330
331<p>A description of each parameter follows:</p>
332
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]333<dd>
334</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]335
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]336<dd> </dd>
337<dl class="dl-horizontal">
338<dt>exception</dt>
339<dd>return any errors or warnings in this structure. </dd>
340
341<dd> </dd>
342</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]343<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="RegisterModule">RegisterModule</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]344
345<p>RegisterModule() adds an entry to the module list. It returns a pointer to the registered entry on success.</p>
346
347<p>The format of the RegisterModule module is:</p>
348
349<pre class="text">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]350ModuleInfo *RegisterModule(const ModuleInfo *module_info,
351 ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]352</pre>
353
354<p>A description of each parameter follows:</p>
355
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]356<dd>
357</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]358
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]359<dd> </dd>
360<dl class="dl-horizontal">
361<dt>info</dt>
362<dd>a pointer to the registered entry is returned. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]363
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]364<dd> </dd>
365<dt>module_info</dt>
366<dd>a pointer to the ModuleInfo structure to register. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]367
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]368<dd> </dd>
369<dt>exception</dt>
370<dd>return any errors or warnings in this structure. </dd>
371
372<dd> </dd>
373</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]374<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="TagToCoderModuleName">TagToCoderModuleName</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]375
376<p>TagToCoderModuleName() munges a module tag and obtains the filename of the corresponding module.</p>
377
378<p>The format of the TagToCoderModuleName module is:</p>
379
380<pre class="text">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]381char *TagToCoderModuleName(const char *tag,char *name)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]382</pre>
383
384<p>A description of each parameter follows:</p>
385
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]386<dd>
387</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]388
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]389<dd> </dd>
390<dl class="dl-horizontal">
391<dt>tag</dt>
392<dd>a character string representing the module tag. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]393
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]394<dd> </dd>
395<dt>name</dt>
396<dd>return the module name here. </dd>
397
398<dd> </dd>
399</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]400<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="TagToFilterModuleName">TagToFilterModuleName</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]401
402<p>TagToFilterModuleName() munges a module tag and returns the filename of the corresponding filter module.</p>
403
404<p>The format of the TagToFilterModuleName module is:</p>
405
406<pre class="text">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]407void TagToFilterModuleName(const char *tag,char name)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]408</pre>
409
410<p>A description of each parameter follows:</p>
411
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]412<dd>
413</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]414
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]415<dd> </dd>
416<dl class="dl-horizontal">
417<dt>tag</dt>
418<dd>a character string representing the module tag. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]419
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]420<dd> </dd>
421<dt>name</dt>
422<dd>return the filter name here. </dd>
423
424<dd> </dd>
425</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]426<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="TagToModuleName">TagToModuleName</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]427
428<p>TagToModuleName() munges the module tag name and returns an upper-case tag name as the input string, and a user-provided format.</p>
429
430<p>The format of the TagToModuleName module is:</p>
431
432<pre class="text">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]433TagToModuleName(const char *tag,const char *format,char *module)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]434</pre>
435
436<p>A description of each parameter follows:</p>
437
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]438<dd>
439</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]440
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]441<dd> </dd>
442<dl class="dl-horizontal">
443<dt>tag</dt>
444<dd>the module tag. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]445
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]446<dd> </dd>
447<dt>format</dt>
448<dd>a sprintf-compatible format string containing s where the upper-case tag name is to be inserted. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]449
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]450<dd> </dd>
451<dt>module</dt>
452<dd>pointer to a destination buffer for the formatted result. </dd>
453
454<dd> </dd>
455</dl>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]456<h2><a href="http://www.imagemagick.org/api/MagickCore/module_8c.html" id="UnregisterModule">UnregisterModule</a></h2>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]457
458<p>UnregisterModule() unloads a module, and invokes its de-registration module. Returns MagickTrue on success, and MagickFalse if there is an error.</p>
459
460<p>The format of the UnregisterModule module is:</p>
461
462<pre class="text">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]463MagickBooleanType UnregisterModule(const ModuleInfo *module_info,
464 ExceptionInfo *exception)
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]465</pre>
466
467<p>A description of each parameter follows:</p>
468
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]469<dd>
470</dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]471
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]472<dd> </dd>
473<dl class="dl-horizontal">
474<dt>module_info</dt>
475<dd>the module info. </dd>
cristy20398432011-08-11 01:31:50 +0000[diff] [blame]476
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]477<dd> </dd>
478<dt>exception</dt>
479<dd>return any errors or warnings in this structure. </dd>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]480
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]481<dd> </dd>
482</dl>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]483</div>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]484 <footer class="magick-footer">
485 <div class="magick-nav-item navbar-left">
cristy85893d32015-05-06 13:44:09 +0000[diff] [blame]486 <a href="../../www/support.html">Donate</a>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]487 </div>
488 <div class="magick-nav-item navbar-right">
489 <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="../../index.html"></a>
490 <noscript>
491 <a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank">
492 <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" border="0"></a>
493 </noscript>
494 </div>
495 <p><a href="../../www/sitemap.html">Sitemap</a> •
496 <a href="../../www/links.html">Related</a> •
497 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Image Studio</a> •
498 <a href="http://jqmagick.imagemagick.org/">JqMagick</a> •
499 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a>
500</p>
501 <p><a href="module.html#">Back to top</a> •
cristyabed55c2015-05-06 17:07:00 +0000[diff] [blame^]502 <a href="http://www.imagemagick.org/script/contact.php">Contact Us</a></p>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]503 </footer>
504</div><!-- /.container -->
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]505
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]506 <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
507 <script src="../../js/bootstrap.min.js"></script>
508 <script type="text/javascript">
509 /* */
510 (function() {
511 var s = document.createElement('offline-script'), t = document.getElementsByTagName('offline-script')[0];
512 s.type = 'text/javascript';
513 s.async = true;
514 s.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto';
515 t.parentNode.insertBefore(s, t);
516 })();
517 /* */
518 </script>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]519</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]520</body>
cristy5a367e42015-05-05 12:39:18 +0000[diff] [blame]521</html>