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