Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / a890294753108889ed477181e5dd0ff5fc605f43 / . / www / api / registry.html
blob: cb2a8c4e2e141073f6129bbe8d93e81ea47c93eb [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +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">
cristy2c839602010-04-03 02:32:08 +0000[diff] [blame]3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]5 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
7 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]8 <style type="text/css" media="all">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]9 @import url("../../www/magick.css");
cristy3de29cc2010-04-15 02:34:44 +0000[diff] [blame]10 </style>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]11 <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"/>
cristy16af1cb2009-12-11 21:38:29 +0000[diff] [blame]25 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]26 <meta name="Distribution" content="Global"/>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]27</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
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]45<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]46
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]47<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]48 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]49</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]50<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]51<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]52 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
53</div>
54<div class="sub">
55 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
56</div>
57<div class="sub">
58 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
59</div>
60<div class="sub">
61 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
62</div>
63<div class="sep"></div>
64<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]65 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]66</div>
67<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]68 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]69</div>
70<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]71 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]72</div>
73<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]74 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]75</div>
76<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]77 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]78</div>
79<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]80 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]81</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]83 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]84</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]86 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]87</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]89 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]90</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]91<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]92<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]93 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]94</div>
95<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]96 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]97</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]99 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]100 </div>
101<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]102 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]103</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]104<div class="menu">
105 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
106</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]108 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]109</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]112 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]115<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]116 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]117</div>
118<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]119 <a title="Site Map: Links"href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]121<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]122<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]123 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]124
125<div class="sponsbox">
126<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]127 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristyb36feb22010-03-26 16:54:37 +0000[diff] [blame]128</div>
129<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]130 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000[diff] [blame]131</div>
132<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]133 <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
cristyc49f7992009-09-22 22:48:40 +0000[diff] [blame]134</div>
135<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]136 <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
cristy916e1922009-10-01 12:52:47 +0000[diff] [blame]137</div>
138<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]139 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]140</div>
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]141<div class="sponsor">
cristya8902942010-07-30 00:49:52 +0000[diff] [blame^]142 <a title="Sponsor: Online-Magazin" href="http://www.unkostenbeitrag.de/">Online-Magazin</a><!-- 20101101000200 -->
cristy73b7d4c2010-06-27 00:31:00 +0000[diff] [blame]143</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]144</div>
145</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]146</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]147
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]148<div class="eastbar">
149 <script type="text/javascript">
150 <!--
151 google_ad_client = "pub-3129977114552745";
152 /* 160x600, created 7/27/10 */
153 google_ad_slot = "0574824969";
154 google_ad_width = 160;
155 google_ad_height = 600;
156 //-->
157 </script>
158 <script type="text/javascript"
159 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
160 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]161</div>
162
163<div class="main">
164
cristye6378132009-10-26 20:05:17 +0000[diff] [blame]165<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 +0000[diff] [blame]166
167<h2><a href="http://www.imagemagick.org/api/MagickCore/registry
168_8c.html" target="source" name="DefineImageRegistry">DefineImageRegistry</a></h2>
169<div class="doc-section">
170
171<p>DefineImageRegistry() associates a key/value pair with the image registry.</p></ol>
172
173<p>The format of the DefineImageRegistry method is:</p>
174
175<pre class="code">
176 MagickBooleanType DefineImageRegistry(const RegistryType type,
177 const char *option,ExceptionInfo *exception)
178</pre>
179
180<p>A description of each parameter follows:</p></ol>
181
182<h5>type</h5>
183<ol><p>the type.</p></ol>
184
185<h5>option</h5>
186<ol><p>the option.</p></ol>
187
188<h5>exception</h5>
189<ol><p>the exception.</p></ol>
190
191 </div>
192<h2><a href="http://www.imagemagick.org/api/MagickCore/registry
193_8c.html" target="source" name="DeleteImageRegistry">DeleteImageRegistry</a></h2>
194<div class="doc-section">
195
196<p>DeleteImageRegistry() deletes a key from the image registry.</p></ol>
197
198<p>The format of the DeleteImageRegistry method is:</p>
199
200<pre class="code">
201 MagickBooleanType DeleteImageRegistry(const char *key)
202</pre>
203
204<p>A description of each parameter follows:</p></ol>
205
206<h5>key</h5>
207<ol><p>the registry.</p></ol>
208
209 </div>
210<h2><a href="http://www.imagemagick.org/api/MagickCore/registry
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]211_8c.html" target="source" name="GetImageRegistry">GetImageRegistry</a></h2>
212<div class="doc-section">
213
214<p>GetImageRegistry() returns a value associated with an image registry key.</p></ol>
215
216<p>The format of the GetImageRegistry method is:</p>
217
218<pre class="code">
219 void *GetImageRegistry(const RegistryType type,const char *key,
220 ExceptionInfo *exception)
221</pre>
222
223<p>A description of each parameter follows:</p></ol>
224
225<h5>type</h5>
226<ol><p>the type.</p></ol>
227
228<h5>key</h5>
229<ol><p>the key.</p></ol>
230
231<h5>exception</h5>
232<ol><p>the exception.</p></ol>
233
234 </div>
235<h2><a href="http://www.imagemagick.org/api/MagickCore/registry
236_8c.html" target="source" name="GetNextImageRegistry">GetNextImageRegistry</a></h2>
237<div class="doc-section">
238
239<p>GetNextImageRegistry() gets the next image registry value.</p></ol>
240
241<p>The format of the GetNextImageRegistry method is:</p>
242
243<pre class="code">
244 char *GetNextImageRegistry(void)
245</pre>
246
247 </div>
248<h2><a href="http://www.imagemagick.org/api/MagickCore/registry
cristye6378132009-10-26 20:05:17 +0000[diff] [blame]249_8c.html" target="source" name="RegistryComponentTerminus">RegistryComponentTerminus</a></h2>
250<div class="doc-section">
251
252<p>RegistryComponentTerminus() destroys the registry component.</p></ol>
253
254<p>The format of the DestroyDefines method is:</p>
255
256<pre class="code">
257 void RegistryComponentTerminus(void)
258</pre>
259
260 </div>
261<h2><a href="http://www.imagemagick.org/api/MagickCore/registry
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]262_8c.html" target="source" name="RemoveImageRegistry">RemoveImageRegistry</a></h2>
263<div class="doc-section">
264
265<p>RemoveImageRegistry() removes a key from the image registry and returns its value.</p></ol>
266
267<p>The format of the RemoveImageRegistry method is:</p>
268
269<pre class="code">
270 void *RemoveImageRegistry(const char *key)
271</pre>
272
273<p>A description of each parameter follows:</p></ol>
274
275<h5>key</h5>
276<ol><p>the registry.</p></ol>
277
278 </div>
279<h2><a href="http://www.imagemagick.org/api/MagickCore/registry
280_8c.html" target="source" name="ResetImageRegistryIterator">ResetImageRegistryIterator</a></h2>
281<div class="doc-section">
282
283<p>ResetImageRegistryIterator() resets the registry iterator. Use it in conjunction with GetNextImageRegistry() to iterate over all the values in the image registry.</p></ol>
284
285<p>The format of the ResetImageRegistryIterator method is:</p>
286
287<pre class="code">
288 ResetImageRegistryIterator(void)
289</pre>
290
291 </div>
292<h2><a href="http://www.imagemagick.org/api/MagickCore/registry
293_8c.html" target="source" name="SetImageRegistry">SetImageRegistry</a></h2>
294<div class="doc-section">
295
296<p>SetImageRegistry() associates a value with an image registry key.</p></ol>
297
298<p>The format of the SetImageRegistry method is:</p>
299
300<pre class="code">
301 MagickBooleanType SetImageRegistry(const RegistryType type,
302 const char *key,const void *value,ExceptionInfo *exception)
303</pre>
304
305<p>A description of each parameter follows:</p></ol>
306
307<h5>type</h5>
308<ol><p>the type.</p></ol>
309
310<h5>key</h5>
311<ol><p>the key.</p></ol>
312
313<h5>value</h5>
314<ol><p>the value.</p></ol>
315
316<h5>exception</h5>
317<ol><p>the exception.</p></ol>
318
319 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]320
321</div>
322
323<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]324 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]325 <span id="linkbar-center">
326 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame^]327 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]328 </span>
329 <span id="linkbar-east">&nbsp;</span>
330 </div>
331 <div class="footer">
332 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
333 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
334 </div>
335 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame^]336 <script type="text/javascript">
337 var _gaq = _gaq || [];
338 _gaq.push(['_setAccount', 'UA-17690367-1']);
339 _gaq.push(['_trackPageview']);
340
341 (function() {
342 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
343 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
344 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
345 })();
346 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]347</body>
348</html>