Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 3ed852eea50f9d4cd633efb8c2b054b8e33c2530 / . / www / api / registry.html
blob: 20bb91e559ca84449b67f77d6215b845310f6a2c [file] [log] [blame]
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame^]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<head>
5 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
6 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
7 <style type="text/css" media="screen,projection"><!--
8 @import url("../../www/magick.css");
9 --></style>
10 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
11 <title>ImageMagick: MagickCore, C API for ImageMagick: The Image Registry</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:, the, image, registry, 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>
27
28<body id="www-imagemagick-org">
29<div class="titlebar">
30<a href="../../index.html">
31 <img src="../../images/script.png" alt="[ImageMagick]"
32 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
33<a href="http://www.networkredux.com">
34 <img src="../../images/networkredux.png" alt="[sponsor]"
35 style="margin: 45px auto; border: 0px; float: left;" /></a>
36<a href="http://www.imagemagick.org/discourse-server/">
37 <img src="../../images/logo.jpg" alt=""
38 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
39<a href="../../index.html">
40 <img src="../../images/sprite.jpg" alt=""
41 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
42</div>
43
44<div class="eastbar">
45
46<div class="menu">
47 <a href="../../index.html">About ImageMagick</a>
48</div>
49<div class="sep"></div>
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>
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>
106<div class="menu">
107 <a href="../../www/download.html">Download</a>
108</div>
109<div class="sep"></div>
110<div class="menu">
111 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
112</div>
113<div class="sep"></div>
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>
121<div class="menu">
122 <a href="../../www/sponsors.html">Sponsors:</a>
123
124<div class="sponsbox">
125<div class="sponsor">
126 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
127</div>
128<div class="sponsor">
129 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
130</div>
131<div class="sponsor">
132 <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
133</div>
134<div class="sponsor">
135 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
136</div>
137<div class="sponsor">
138 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201001010120 Buchhorn -->
139</div>
140</div>
141</div>
142
143
144</div>
145
146<div class="main">
147
148<p class="navigation-index">[<a href="#DefineImageRegistry">DefineImageRegistry</a> &bull; <a href="#DeleteImageRegistry">DeleteImageRegistry</a> &bull; <a href="#DestroyImageRegistry">DestroyImageRegistry</a> &bull; <a href="#GetImageRegistry">GetImageRegistry</a> &bull; <a href="#GetNextImageRegistry">GetNextImageRegistry</a> &bull; <a href="#RemoveImageRegistry">RemoveImageRegistry</a> &bull; <a href="#ResetImageRegistryIterator">ResetImageRegistryIterator</a> &bull; <a href="#SetImageRegistry">SetImageRegistry</a>]</p>
149
150<h2><a href="http://www.imagemagick.org/api/MagickCore/registry
151_8c.html" target="source" name="DefineImageRegistry">DefineImageRegistry</a></h2>
152<div class="doc-section">
153
154<p>DefineImageRegistry() associates a key/value pair with the image registry.</p></ol>
155
156<p>The format of the DefineImageRegistry method is:</p>
157
158<pre class="code">
159 MagickBooleanType DefineImageRegistry(const RegistryType type,
160 const char *option,ExceptionInfo *exception)
161</pre>
162
163<p>A description of each parameter follows:</p></ol>
164
165<h5>type</h5>
166<ol><p>the type.</p></ol>
167
168<h5>option</h5>
169<ol><p>the option.</p></ol>
170
171<h5>exception</h5>
172<ol><p>the exception.</p></ol>
173
174 </div>
175<h2><a href="http://www.imagemagick.org/api/MagickCore/registry
176_8c.html" target="source" name="DeleteImageRegistry">DeleteImageRegistry</a></h2>
177<div class="doc-section">
178
179<p>DeleteImageRegistry() deletes a key from the image registry.</p></ol>
180
181<p>The format of the DeleteImageRegistry method is:</p>
182
183<pre class="code">
184 MagickBooleanType DeleteImageRegistry(const char *key)
185</pre>
186
187<p>A description of each parameter follows:</p></ol>
188
189<h5>key</h5>
190<ol><p>the registry.</p></ol>
191
192 </div>
193<h2><a href="http://www.imagemagick.org/api/MagickCore/registry
194_8c.html" target="source" name="DestroyImageRegistry">DestroyImageRegistry</a></h2>
195<div class="doc-section">
196
197<p>DestroyImageRegistry() releases memory associated with the image registry.</p></ol>
198
199<p>The format of the DestroyDefines method is:</p>
200
201<pre class="code">
202 void DestroyImageRegistry(void)
203</pre>
204
205 </div>
206<h2><a href="http://www.imagemagick.org/api/MagickCore/registry
207_8c.html" target="source" name="GetImageRegistry">GetImageRegistry</a></h2>
208<div class="doc-section">
209
210<p>GetImageRegistry() returns a value associated with an image registry key.</p></ol>
211
212<p>The format of the GetImageRegistry method is:</p>
213
214<pre class="code">
215 void *GetImageRegistry(const RegistryType type,const char *key,
216 ExceptionInfo *exception)
217</pre>
218
219<p>A description of each parameter follows:</p></ol>
220
221<h5>type</h5>
222<ol><p>the type.</p></ol>
223
224<h5>key</h5>
225<ol><p>the key.</p></ol>
226
227<h5>exception</h5>
228<ol><p>the exception.</p></ol>
229
230 </div>
231<h2><a href="http://www.imagemagick.org/api/MagickCore/registry
232_8c.html" target="source" name="GetNextImageRegistry">GetNextImageRegistry</a></h2>
233<div class="doc-section">
234
235<p>GetNextImageRegistry() gets the next image registry value.</p></ol>
236
237<p>The format of the GetNextImageRegistry method is:</p>
238
239<pre class="code">
240 char *GetNextImageRegistry(void)
241</pre>
242
243 </div>
244<h2><a href="http://www.imagemagick.org/api/MagickCore/registry
245_8c.html" target="source" name="RemoveImageRegistry">RemoveImageRegistry</a></h2>
246<div class="doc-section">
247
248<p>RemoveImageRegistry() removes a key from the image registry and returns its value.</p></ol>
249
250<p>The format of the RemoveImageRegistry method is:</p>
251
252<pre class="code">
253 void *RemoveImageRegistry(const char *key)
254</pre>
255
256<p>A description of each parameter follows:</p></ol>
257
258<h5>key</h5>
259<ol><p>the registry.</p></ol>
260
261 </div>
262<h2><a href="http://www.imagemagick.org/api/MagickCore/registry
263_8c.html" target="source" name="ResetImageRegistryIterator">ResetImageRegistryIterator</a></h2>
264<div class="doc-section">
265
266<p>ResetImageRegistryIterator() resets the registry iterator. Use it in conjunction with GetNextImageRegistry() to iterate over all the values in the image registry.</p></ol>
267
268<p>The format of the ResetImageRegistryIterator method is:</p>
269
270<pre class="code">
271 ResetImageRegistryIterator(void)
272</pre>
273
274 </div>
275<h2><a href="http://www.imagemagick.org/api/MagickCore/registry
276_8c.html" target="source" name="SetImageRegistry">SetImageRegistry</a></h2>
277<div class="doc-section">
278
279<p>SetImageRegistry() associates a value with an image registry key.</p></ol>
280
281<p>The format of the SetImageRegistry method is:</p>
282
283<pre class="code">
284 MagickBooleanType SetImageRegistry(const RegistryType type,
285 const char *key,const void *value,ExceptionInfo *exception)
286</pre>
287
288<p>A description of each parameter follows:</p></ol>
289
290<h5>type</h5>
291<ol><p>the type.</p></ol>
292
293<h5>key</h5>
294<ol><p>the key.</p></ol>
295
296<h5>value</h5>
297<ol><p>the value.</p></ol>
298
299<h5>exception</h5>
300<ol><p>the exception.</p></ol>
301
302 </div>
303
304</div>
305
306<div id="linkbar">
307 <!-- <span id="linkbar-west">&nbsp;</span> -->
308 <span id="linkbar-center">
309 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
310 <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;
311 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
312 </span>
313 <span id="linkbar-east">&nbsp;</span>
314 </div>
315 <div class="footer">
316 <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>
317 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
318 </div>
319 <div style="clear: both; margin: 0; width: 100%; "></div>
320</body>
321</html>