Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / de27d7631fa4cbb36c8bde6001d2c522774b3712 / . / www / api / registry.html
blob: e937d84e09d68b94a2131ed7a8d07dab5374c170 [file] [log] [blame]
Cristy594d2772015-11-15 10:47:42 -0500[diff] [blame]1
2
3
4
cristy29dc8652015-05-12 16:26:21 +0000[diff] [blame]5<!DOCTYPE html>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]6<html lang="en">
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]7<head>
Cristy594d2772015-11-15 10:47:42 -0500[diff] [blame]8 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame]9 <title>ImageMagick: MagickCore, C API for ImageMagick: The Image Registry</title>
Cristy594d2772015-11-15 10:47:42 -0500[diff] [blame]10 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
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:, the, image, registry, 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"/>
Cristyce4a3552015-12-14 13:53:35 -0500[diff] [blame]22 <meta name="copyright" content="Copyright (c) 1999-2015 ImageMagick Studio LLC"/>
Cristy594d2772015-11-15 10:47:42 -0500[diff] [blame]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"/>
27 <link rel="stylesheet" href="../css/magick.html"/>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]28</head>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]29<body>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]30<div class="main">
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]31<div class="magick-masthead">
32 <div class="container">
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]33 <script async="async" src="http://localhost/pagead/js/adsbygoogle.js"></script> <ins class="adsbygoogle"
Cristy594d2772015-11-15 10:47:42 -0500[diff] [blame]34 style="display:block"
35 data-ad-client="ca-pub-3129977114552745"
36 data-ad-slot="6345125851"
37 data-ad-format="auto"></ins>
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame]38 <script>
Cristy542697a2015-10-12 20:10:32 -0400[diff] [blame]39 (adsbygoogle = window.adsbygoogle || []).push({});
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]40 </script>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]41 <nav class="magick-nav">
cristy2f563d42015-05-06 23:36:51 +0000[diff] [blame]42 <a class="magick-nav-item " href="../index.html">Home</a>
cristyea2793e2015-05-31 16:52:26 +0000[diff] [blame]43 <a class="magick-nav-item " href="../binary-releases.html">Download</a>
cristy38185362015-05-07 20:09:56 +0000[diff] [blame]44 <a class="magick-nav-item " href="../command-line-tools.html">Tools</a>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]45 <a class="magick-nav-item " href="../command-line-processing.html">Command-line</a>
cristyea2793e2015-05-31 16:52:26 +0000[diff] [blame]46 <a class="magick-nav-item " href="../resources.html">Resources</a>
47 <a class="magick-nav-item " href="api.html">Develop</a>
cristy5b8fe762015-06-09 16:24:03 +0000[diff] [blame]48 <a class="magick-nav-item " href="http://nextgen.imagemagick.org/script/search.php">Search</a>
cristya1890f02015-05-15 23:32:44 +0000[diff] [blame]49 <a class="magick-nav-item pull-right" href="http://www.imagemagick.org/discourse-server/">Community</a>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]50 </nav>
51 </div>
52</div>
53<div class="container">
cristy4e638cd2015-05-07 16:47:40 +0000[diff] [blame]54<div class="magick-header">
Cristy594d2772015-11-15 10:47:42 -0500[diff] [blame]55<p class="text-center"><a href="registry.html#DefineImageRegistry">DefineImageRegistry</a> &#8226; <a href="registry.html#DeleteImageRegistry">DeleteImageRegistry</a> &#8226; <a href="registry.html#GetImageRegistry">GetImageRegistry</a> &#8226; <a href="registry.html#GetNextImageRegistry">GetNextImageRegistry</a> &#8226; <a href="registry.html#RegistryComponentTerminus">RegistryComponentTerminus</a> &#8226; <a href="registry.html#RemoveImageRegistry">RemoveImageRegistry</a> &#8226; <a href="registry.html#ResetImageRegistryIterator">ResetImageRegistryIterator</a> &#8226; <a href="registry.html#SetImageRegistry">SetImageRegistry</a></p>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]56
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]57<h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="DefineImageRegistry">DefineImageRegistry</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]58
59<p>DefineImageRegistry() associates a key/value pair with the image registry.</p>
60
61<p>The format of the DefineImageRegistry method is:</p>
62
63<pre class="text">
64MagickBooleanType DefineImageRegistry(const RegistryType type,
65 const char *option,ExceptionInfo *exception)
66</pre>
67
68<p>A description of each parameter follows:</p>
69
70<dd>
71</dd>
72
73<dd> </dd>
74<dl class="dl-horizontal">
75<dt>type</dt>
76<dd>the type. </dd>
77
78<dd> </dd>
79<dt>option</dt>
80<dd>the option. </dd>
81
82<dd> </dd>
83<dt>exception</dt>
84<dd>the exception. </dd>
85
86<dd> </dd>
87</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]88<h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="DeleteImageRegistry">DeleteImageRegistry</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]89
90<p>DeleteImageRegistry() deletes a key from the image registry.</p>
91
92<p>The format of the DeleteImageRegistry method is:</p>
93
94<pre class="text">
95MagickBooleanType DeleteImageRegistry(const char *key)
96</pre>
97
98<p>A description of each parameter follows:</p>
99
100<dd>
101</dd>
102
103<dd> </dd>
104<dl class="dl-horizontal">
105<dt>key</dt>
106<dd>the registry. </dd>
107
108<dd> </dd>
109</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]110<h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="GetImageRegistry">GetImageRegistry</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]111
112<p>GetImageRegistry() returns a value associated with an image registry key.</p>
113
114<p>The format of the GetImageRegistry method is:</p>
115
116<pre class="text">
117void *GetImageRegistry(const RegistryType type,const char *key,
118 ExceptionInfo *exception)
119</pre>
120
121<p>A description of each parameter follows:</p>
122
123<dd>
124</dd>
125
126<dd> </dd>
127<dl class="dl-horizontal">
128<dt>type</dt>
129<dd>the type. </dd>
130
131<dd> </dd>
132<dt>key</dt>
133<dd>the key. </dd>
134
135<dd> </dd>
136<dt>exception</dt>
137<dd>the exception. </dd>
138
139<dd> </dd>
140</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]141<h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="GetNextImageRegistry">GetNextImageRegistry</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]142
143<p>GetNextImageRegistry() gets the next image registry value.</p>
144
145<p>The format of the GetNextImageRegistry method is:</p>
146
147<pre class="text">
148char *GetNextImageRegistry(void)
149</pre>
150
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]151<h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="RegistryComponentTerminus">RegistryComponentTerminus</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]152
153<p>RegistryComponentTerminus() destroys the registry component.</p>
154
155<p>The format of the DestroyDefines method is:</p>
156
157<pre class="text">
158void RegistryComponentTerminus(void)
159</pre>
160
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]161<h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="RemoveImageRegistry">RemoveImageRegistry</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]162
163<p>RemoveImageRegistry() removes a key from the image registry and returns its value.</p>
164
165<p>The format of the RemoveImageRegistry method is:</p>
166
167<pre class="text">
168void *RemoveImageRegistry(const char *key)
169</pre>
170
171<p>A description of each parameter follows:</p>
172
173<dd>
174</dd>
175
176<dd> </dd>
177<dl class="dl-horizontal">
178<dt>key</dt>
179<dd>the registry. </dd>
180
181<dd> </dd>
182</dl>
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]183<h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="ResetImageRegistryIterator">ResetImageRegistryIterator</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]184
185<p>ResetImageRegistryIterator() resets the registry iterator. Use it in conjunction with GetNextImageRegistry() to iterate over all the values in the image registry.</p>
186
187<p>The format of the ResetImageRegistryIterator method is:</p>
188
189<pre class="text">
190ResetImageRegistryIterator(void)
191</pre>
192
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]193<h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="SetImageRegistry">SetImageRegistry</a></h2>
cristycecc9492015-06-09 16:53:50 +0000[diff] [blame]194
195<p>SetImageRegistry() associates a value with an image registry key.</p>
196
197<p>The format of the SetImageRegistry method is:</p>
198
199<pre class="text">
200MagickBooleanType SetImageRegistry(const RegistryType type,
201 const char *key,const void *value,ExceptionInfo *exception)
202</pre>
203
204<p>A description of each parameter follows:</p>
205
206<dd>
207</dd>
208
209<dd> </dd>
210<dl class="dl-horizontal">
211<dt>type</dt>
212<dd>the type. </dd>
213
214<dd> </dd>
215<dt>key</dt>
216<dd>the key. </dd>
217
218<dd> </dd>
219<dt>value</dt>
220<dd>the value. </dd>
221
222<dd> </dd>
223<dt>exception</dt>
224<dd>the exception. </dd>
225
226<dd> </dd>
227</dl>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]228</div>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]229 <footer class="magick-footer">
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame]230 <p><a href="../support.html">Donate</a> •
231 <a href="../sitemap.html">Sitemap</a> •
cristy38185362015-05-07 20:09:56 +0000[diff] [blame]232 <a href="../links.html">Related</a> •
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame]233 <a href="../architecture.html">Architecture</a>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]234</p>
235 <p><a href="registry.html#">Back to top</a> •
cristyea2793e2015-05-31 16:52:26 +0000[diff] [blame]236 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
cristy5b8fe762015-06-09 16:24:03 +0000[diff] [blame]237 <a href="http://nextgen.imagemagick.org/script/contact.php">Contact Us</a></p>
Cristyce4a3552015-12-14 13:53:35 -0500[diff] [blame]238 <p><small>© 1999-2015 ImageMagick Studio LLC</small></p>
cristy44443b92015-05-05 00:06:07 +0000[diff] [blame]239 </footer>
240</div><!-- /.container -->
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]241
Cristye93be682015-11-26 09:07:51 -0500[diff] [blame]242 <script src="https://localhost/ajax/libs/jquery/1.11.3/jquery.min.js"></script>
cristy29f2c972015-07-28 13:37:46 +0000[diff] [blame]243 <script src="http://nextgen.imagemagick.org/js/magick.html"></script>
cristy44cbd482013-08-04 20:53:36 +0000[diff] [blame]244</div>
cristy06f63f22012-10-31 00:50:07 +0000[diff] [blame]245</body>
cristy5a367e42015-05-05 12:39:18 +0000[diff] [blame]246</html>