blob: 1753770931483f7b143982b0f906bb025080fd1f [file] [log] [blame]
cristyf3bb4782009-09-08 13:10:04 +00001<!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>
cristy1f9e1ed2009-11-18 04:09:38 +00005 <meta http-equiv="Content-Type" value="application/xhtml+xml" />
cristyf3bb4782009-09-08 13:10:04 +00006 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
7 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
8 <style type="text/css" media="screen,projection"><!--
9 @import url("../../www/magick.css");
10 --></style>
cristy3ed852e2009-09-05 21:47:34 +000011 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
12 <title>ImageMagick: MagickCore, C API for ImageMagick: The Image Registry</title>
13 <meta http-equiv="Content-Language" content="en-US"/>
14 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
15 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
16 <meta name="Generator" content="PHP"/>
17 <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"/>
18 <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."/>
19 <meta name="Rating" content="GENERAL"/>
20 <meta name="Robots" content="INDEX, FOLLOW"/>
21 <meta name="Generator" content="ImageMagick Studio LLC"/>
22 <meta name="Author" content="ImageMagick Studio LLC"/>
23 <meta name="Revisit-after" content="2 DAYS"/>
24 <meta name="Resource-type" content="document"/>
25 <meta name="Copyright" content="Copyright (c) 1999-2009 ImageMagick Studio LLC"/>
26 <meta name="Distribution" content="Global"/>
cristyf3bb4782009-09-08 13:10:04 +000027</head>
28
29<body id="www-imagemagick-org">
30<div class="titlebar">
31<a href="../../index.html">
32 <img src="../../images/script.png" alt="[ImageMagick]"
33 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
34<a href="http://www.networkredux.com">
35 <img src="../../images/networkredux.png" alt="[sponsor]"
36 style="margin: 45px auto; border: 0px; float: left;" /></a>
37<a href="http://www.imagemagick.org/discourse-server/">
38 <img src="../../images/logo.jpg" alt=""
39 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
40<a href="../../index.html">
41 <img src="../../images/sprite.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43</div>
44
45<div class="eastbar">
46
cristy3ed852e2009-09-05 21:47:34 +000047<div class="menu">
48 <a href="../../index.html">About ImageMagick</a>
49</div>
cristyf3bb4782009-09-08 13:10:04 +000050<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000051<div class="menu">
52 <a href="../../www/command-line-tools.html">Command-line Tools</a>
53</div>
54<div class="sub">
55 <a href="../../www/command-line-processing.html">Processing</a>
56</div>
57<div class="sub">
58 <a href="../../www/command-line-options.html">Options</a>
59</div>
60<div class="sub">
61 <a href="http://www.imagemagick.org/Usage/">Usage</a>
62</div>
63<div class="menu">
64 <a href="../../www/api.html">Program Interfaces</a>
65</div>
66<div class="sub">
67 <a href="../../www/magick-wand.html">MagickWand</a>
68</div>
69<div class="sub">
70 <a href="../../www/magick-core.html">MagickCore</a>
71</div>
72<div class="sub">
73 <a href="../../www/perl-magick.html">PerlMagick</a>
74</div>
75<div class="sub">
76 <a href="../../Magick++/">Magick++</a>
77</div>
78<div class="menu">
79 <a href="../../www/architecture.html">Architecture</a>
80</div>
cristyf3bb4782009-09-08 13:10:04 +000081<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000082<div class="menu">
83 <a href="../../www/install-source.html">Install from Source</a>
84</div>
85<div class="sub">
86 <a href="../../www/install-source.html#unix">Unix</a>
87</div>
88<div class="sub">
89 <a href="../../www/install-source.html#windows">Windows</a>
90 </div>
91<div class="menu">
92 <a href="../../www/binary-releases.html">Binary Releases</a>
93</div>
94<div class="sub">
95 <a href="../../www/binary-releases.html#unix">Unix</a>
96</div>
97<div class="sub">
98 <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
99</div>
100<div class="sub">
101 <a href="../../www/binary-releases.html#windows">Windows</a>
102</div>
103<div class="menu">
104 <a href="../../www/resources.html">Resources</a>
105</div>
cristyf3bb4782009-09-08 13:10:04 +0000106<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000107<div class="menu">
108 <a href="../../www/download.html">Download</a>
109</div>
cristyf3bb4782009-09-08 13:10:04 +0000110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000111<div class="menu">
112 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
113</div>
cristyf3bb4782009-09-08 13:10:04 +0000114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000115<div class="menu">
116 <a href="../../www/sitemap.html">Site Map</a>
117</div>
118<div class="sub">
119 <a href="../../www/links.html">Links</a>
120</div>
cristyf3bb4782009-09-08 13:10:04 +0000121<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000122<div class="menu">
123 <a href="../../www/sponsors.html">Sponsors:</a>
124
125<div class="sponsbox">
126<div class="sponsor">
cristyd97b6ed2009-11-20 01:02:19 +0000127 <a href="http://www.hygi.de">Reinigungsmittel</a><!-- 201002000400+ -->
cristy1f9e1ed2009-11-18 04:09:38 +0000128</div>
129<div class="sponsor">
130 <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
cristyc49f7992009-09-22 22:48:40 +0000131</div>
132<div class="sponsor">
cristy0f61e612009-11-10 20:03:57 +0000133 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201004010120 Buchhorn -->
134</div>
135<div class="sponsor">
136 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
cristy916e1922009-10-01 12:52:47 +0000137</div>
138<div class="sponsor">
cristyb4c03bb2009-09-27 13:55:46 +0000139 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
140</div>
141<div class="sponsor">
cristyf3bb4782009-09-08 13:10:04 +0000142 <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
143</div>
144<div class="sponsor">
cristy3ed852e2009-09-05 21:47:34 +0000145 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
146</div>
147<div class="sponsor">
cristy3ed852e2009-09-05 21:47:34 +0000148 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
149</div>
cristy3ed852e2009-09-05 21:47:34 +0000150</div>
151</div>
cristyf3bb4782009-09-08 13:10:04 +0000152
153
154</div>
155
156<div class="main">
157
cristye6378132009-10-26 20:05:17 +0000158<p class="navigation-index">[<a href="#DefineImageRegistry">DefineImageRegistry</a> &bull; <a href="#DeleteImageRegistry">DeleteImageRegistry</a> &bull; <a href="#GetImageRegistry">GetImageRegistry</a> &bull; <a href="#GetNextImageRegistry">GetNextImageRegistry</a> &bull; <a href="#RegistryComponentTerminus">RegistryComponentTerminus</a> &bull; <a href="#RemoveImageRegistry">RemoveImageRegistry</a> &bull; <a href="#ResetImageRegistryIterator">ResetImageRegistryIterator</a> &bull; <a href="#SetImageRegistry">SetImageRegistry</a>]</p>
cristy3ed852e2009-09-05 21:47:34 +0000159
160<h2><a href="http://www.imagemagick.org/api/MagickCore/registry
161_8c.html" target="source" name="DefineImageRegistry">DefineImageRegistry</a></h2>
162<div class="doc-section">
163
164<p>DefineImageRegistry() associates a key/value pair with the image registry.</p></ol>
165
166<p>The format of the DefineImageRegistry method is:</p>
167
168<pre class="code">
169 MagickBooleanType DefineImageRegistry(const RegistryType type,
170 const char *option,ExceptionInfo *exception)
171</pre>
172
173<p>A description of each parameter follows:</p></ol>
174
175<h5>type</h5>
176<ol><p>the type.</p></ol>
177
178<h5>option</h5>
179<ol><p>the option.</p></ol>
180
181<h5>exception</h5>
182<ol><p>the exception.</p></ol>
183
184 </div>
185<h2><a href="http://www.imagemagick.org/api/MagickCore/registry
186_8c.html" target="source" name="DeleteImageRegistry">DeleteImageRegistry</a></h2>
187<div class="doc-section">
188
189<p>DeleteImageRegistry() deletes a key from the image registry.</p></ol>
190
191<p>The format of the DeleteImageRegistry method is:</p>
192
193<pre class="code">
194 MagickBooleanType DeleteImageRegistry(const char *key)
195</pre>
196
197<p>A description of each parameter follows:</p></ol>
198
199<h5>key</h5>
200<ol><p>the registry.</p></ol>
201
202 </div>
203<h2><a href="http://www.imagemagick.org/api/MagickCore/registry
cristy3ed852e2009-09-05 21:47:34 +0000204_8c.html" target="source" name="GetImageRegistry">GetImageRegistry</a></h2>
205<div class="doc-section">
206
207<p>GetImageRegistry() returns a value associated with an image registry key.</p></ol>
208
209<p>The format of the GetImageRegistry method is:</p>
210
211<pre class="code">
212 void *GetImageRegistry(const RegistryType type,const char *key,
213 ExceptionInfo *exception)
214</pre>
215
216<p>A description of each parameter follows:</p></ol>
217
218<h5>type</h5>
219<ol><p>the type.</p></ol>
220
221<h5>key</h5>
222<ol><p>the key.</p></ol>
223
224<h5>exception</h5>
225<ol><p>the exception.</p></ol>
226
227 </div>
228<h2><a href="http://www.imagemagick.org/api/MagickCore/registry
229_8c.html" target="source" name="GetNextImageRegistry">GetNextImageRegistry</a></h2>
230<div class="doc-section">
231
232<p>GetNextImageRegistry() gets the next image registry value.</p></ol>
233
234<p>The format of the GetNextImageRegistry method is:</p>
235
236<pre class="code">
237 char *GetNextImageRegistry(void)
238</pre>
239
240 </div>
241<h2><a href="http://www.imagemagick.org/api/MagickCore/registry
cristye6378132009-10-26 20:05:17 +0000242_8c.html" target="source" name="RegistryComponentTerminus">RegistryComponentTerminus</a></h2>
243<div class="doc-section">
244
245<p>RegistryComponentTerminus() destroys the registry component.</p></ol>
246
247<p>The format of the DestroyDefines method is:</p>
248
249<pre class="code">
250 void RegistryComponentTerminus(void)
251</pre>
252
253 </div>
254<h2><a href="http://www.imagemagick.org/api/MagickCore/registry
cristy3ed852e2009-09-05 21:47:34 +0000255_8c.html" target="source" name="RemoveImageRegistry">RemoveImageRegistry</a></h2>
256<div class="doc-section">
257
258<p>RemoveImageRegistry() removes a key from the image registry and returns its value.</p></ol>
259
260<p>The format of the RemoveImageRegistry method is:</p>
261
262<pre class="code">
263 void *RemoveImageRegistry(const char *key)
264</pre>
265
266<p>A description of each parameter follows:</p></ol>
267
268<h5>key</h5>
269<ol><p>the registry.</p></ol>
270
271 </div>
272<h2><a href="http://www.imagemagick.org/api/MagickCore/registry
273_8c.html" target="source" name="ResetImageRegistryIterator">ResetImageRegistryIterator</a></h2>
274<div class="doc-section">
275
276<p>ResetImageRegistryIterator() resets the registry iterator. Use it in conjunction with GetNextImageRegistry() to iterate over all the values in the image registry.</p></ol>
277
278<p>The format of the ResetImageRegistryIterator method is:</p>
279
280<pre class="code">
281 ResetImageRegistryIterator(void)
282</pre>
283
284 </div>
285<h2><a href="http://www.imagemagick.org/api/MagickCore/registry
286_8c.html" target="source" name="SetImageRegistry">SetImageRegistry</a></h2>
287<div class="doc-section">
288
289<p>SetImageRegistry() associates a value with an image registry key.</p></ol>
290
291<p>The format of the SetImageRegistry method is:</p>
292
293<pre class="code">
294 MagickBooleanType SetImageRegistry(const RegistryType type,
295 const char *key,const void *value,ExceptionInfo *exception)
296</pre>
297
298<p>A description of each parameter follows:</p></ol>
299
300<h5>type</h5>
301<ol><p>the type.</p></ol>
302
303<h5>key</h5>
304<ol><p>the key.</p></ol>
305
306<h5>value</h5>
307<ol><p>the value.</p></ol>
308
309<h5>exception</h5>
310<ol><p>the exception.</p></ol>
311
312 </div>
cristyf3bb4782009-09-08 13:10:04 +0000313
314</div>
315
316<div id="linkbar">
317 <!-- <span id="linkbar-west">&nbsp;</span> -->
318 <span id="linkbar-center">
319 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
320 <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;
cristy701db312009-11-20 03:14:08 +0000321 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristyf3bb4782009-09-08 13:10:04 +0000322 </span>
323 <span id="linkbar-east">&nbsp;</span>
324 </div>
325 <div class="footer">
326 <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>
327 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
328 </div>
329 <div style="clear: both; margin: 0; width: 100%; "></div>
330</body>
331</html>