Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / 18f8ee4f880cde0219ebdef3f2afd83043a7907e / . / www / api / property.html
blob: 4fd815ae40830ae35e6c4eae29133ba29065341d [file] [log] [blame]
cristyf3bb4782009-09-08 13:10:04 +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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]10 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
11 <title>ImageMagick: MagickCore, C API for ImageMagick: Get/Set Image Properties</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:, get/set, image, properties, 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"/>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]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
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]46<div class="menu">
47 <a href="../../index.html">About ImageMagick</a>
48</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]49<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]80<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]105<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]106<div class="menu">
107 <a href="../../www/download.html">Download</a>
108</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]109<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]110<div class="menu">
111 <a href="../http://www.imagemagick.org/script/search.php">Search</a>
112</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]113<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]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>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]120<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]121<div class="menu">
122 <a href="../../www/sponsors.html">Sponsors:</a>
123
124<div class="sponsbox">
125<div class="sponsor">
cristyb4c03bb2009-09-27 13:55:46 +0000[diff] [blame]126 <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
127</div>
128<div class="sponsor">
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]129 <a href="http://www.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
130</div>
131<div class="sponsor">
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]132 <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
133</div>
134<div class="sponsor">
135 <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
136</div>
137<div class="sponsor">
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]138 <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
139</div>
140<div class="sponsor">
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]141 <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201002010120 Buchhorn -->
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]142</div>
143</div>
144</div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]145
146
147</div>
148
149<div class="main">
150
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]151<p class="navigation-index">[<a href="#CloneImageProperties">CloneImageProperties</a> &bull; <a href="#DefineImageProperty">DefineImageProperty</a> &bull; <a href="#DeleteImageProperty">DeleteImageProperty</a> &bull; <a href="#DestroyImageProperties">DestroyImageProperties</a> &bull; <a href="#FormatImageProperty">FormatImageProperty</a> &bull; <a href="#GetImageProperty">GetImageProperty</a> &bull; <a href="#GetNextImageProperty">GetNextImageProperty</a> &bull; <a href="#InterpretImageProperties">InterpretImageProperties</a> &bull; <a href="#RemoveImageProperty">RemoveImageProperty</a> &bull; <a href="#ResetImagePropertyIterator">ResetImagePropertyIterator</a> &bull; <a href="#SetImageProperty">SetImageProperty</a>]</p>
152
153<h2><a href="http://www.imagemagick.org/api/MagickCore/property
154_8c.html" target="source" name="CloneImageProperties">CloneImageProperties</a></h2>
155<div class="doc-section">
156
157<p>CloneImageProperties() clones one or more image properties.</p></ol>
158
159<p>The format of the CloneImageProperties method is:</p>
160
161<pre class="code">
162 MagickBooleanType CloneImageProperties(Image *image,
163 const Image *clone_image)
164</pre>
165
166<p>A description of each parameter follows:</p></ol>
167
168<h5>image</h5>
169<ol><p>the image.</p></ol>
170
171<h5>clone_image</h5>
172<ol><p>the clone image.</p></ol>
173
174 </div>
175<h2><a href="http://www.imagemagick.org/api/MagickCore/property
176_8c.html" target="source" name="DefineImageProperty">DefineImageProperty</a></h2>
177<div class="doc-section">
178
179<p>DefineImageProperty() associates a key/value pair with an image property.</p></ol>
180
181<p>The format of the DefineImageProperty method is:</p>
182
183<pre class="code">
184 MagickBooleanType DefineImageProperty(Image *image,
185 const char *property)
186</pre>
187
188<p>A description of each parameter follows:</p></ol>
189
190<h5>image</h5>
191<ol><p>the image.</p></ol>
192
193<h5>property</h5>
194<ol><p>the image property.</p></ol>
195
196 </div>
197<h2><a href="http://www.imagemagick.org/api/MagickCore/property
198_8c.html" target="source" name="DeleteImageProperty">DeleteImageProperty</a></h2>
199<div class="doc-section">
200
201<p>DeleteImageProperty() deletes an image property.</p></ol>
202
203<p>The format of the DeleteImageProperty method is:</p>
204
205<pre class="code">
206 MagickBooleanType DeleteImageProperty(Image *image,const char *property)
207</pre>
208
209<p>A description of each parameter follows:</p></ol>
210
211<h5>image</h5>
212<ol><p>the image.</p></ol>
213
214<h5>property</h5>
215<ol><p>the image property.</p></ol>
216
217 </div>
218<h2><a href="http://www.imagemagick.org/api/MagickCore/property
219_8c.html" target="source" name="DestroyImageProperties">DestroyImageProperties</a></h2>
220<div class="doc-section">
221
222<p>DestroyImageProperties() releases memory associated with image property values.</p></ol>
223
224<p>The format of the DestroyDefines method is:</p>
225
226<pre class="code">
227 void DestroyImageProperties(Image *image)
228</pre>
229
230<p>A description of each parameter follows:</p></ol>
231
232<h5>image</h5>
233<ol><p>the image.</p></ol>
234
235 </div>
236<h2><a href="http://www.imagemagick.org/api/MagickCore/property
237_8c.html" target="source" name="FormatImageProperty">FormatImageProperty</a></h2>
238<div class="doc-section">
239
240<p>FormatImageProperty() permits formatted property/value pairs to be saved as an image proporty.</p></ol>
241
242<p>The format of the FormatImageProperty method is:</p>
243
244<pre class="code">
245 MagickBooleanType FormatImageProperty(Image *image,const char *property,
246 const char *format,...)
247</pre>
248
249<p>A description of each parameter follows.</p></ol>
250
251<h5> image</h5>
252<ol><p>The image.</p></ol>
253
254<h5> property</h5>
255<ol><p>The attribute property.</p></ol>
256
257<h5> format</h5>
258<ol><p>A string describing the format to use to write the remaining arguments.</p></ol>
259
260 </div>
261<h2><a href="http://www.imagemagick.org/api/MagickCore/property
262_8c.html" target="source" name="GetImageProperty">GetImageProperty</a></h2>
263<div class="doc-section">
264
265<p>GetImageProperty() gets a value associated with an image property.</p></ol>
266
267<p>The format of the GetImageProperty method is:</p>
268
269<pre class="code">
270 const char *GetImageProperty(const Image *image,const char *key)
271</pre>
272
273<p>A description of each parameter follows:</p></ol>
274
275<h5>image</h5>
276<ol><p>the image.</p></ol>
277
278<h5>key</h5>
279<ol><p>the key.</p></ol>
280
281 </div>
282<h2><a href="http://www.imagemagick.org/api/MagickCore/property
283_8c.html" target="source" name="GetNextImageProperty">GetNextImageProperty</a></h2>
284<div class="doc-section">
285
286<p>GetNextImageProperty() gets the next image property value.</p></ol>
287
288<p>The format of the GetNextImageProperty method is:</p>
289
290<pre class="code">
291 char *GetNextImageProperty(const Image *image)
292</pre>
293
294<p>A description of each parameter follows:</p></ol>
295
296<h5>image</h5>
297<ol><p>the image.</p></ol>
298
299 </div>
300<h2><a href="http://www.imagemagick.org/api/MagickCore/property
301_8c.html" target="source" name="InterpretImageProperties">InterpretImageProperties</a></h2>
302<div class="doc-section">
303
304<p>InterpretImageProperties() replaces any embedded formatting characters with the appropriate image property and returns the interpretted text.</p></ol>
305
306<p>The format of the InterpretImageProperties method is:</p>
307
308<pre class="code">
309 char *InterpretImageProperties(const ImageInfo *image_info,Image *image,
310 const char *embed_text)
311</pre>
312
313<p>A description of each parameter follows:</p></ol>
314
315<h5>image_info</h5>
316<ol><p>the image info.</p></ol>
317
318<h5>image</h5>
319<ol><p>the image.</p></ol>
320
321<h5>embed_text</h5>
322<ol><p>the address of a character string containing the embedded formatting characters.</p></ol>
323
324 </div>
325<h2><a href="http://www.imagemagick.org/api/MagickCore/property
326_8c.html" target="source" name="RemoveImageProperty">RemoveImageProperty</a></h2>
327<div class="doc-section">
328
329<p>RemoveImageProperty() removes a property from the image and returns its value.</p></ol>
330
331<p>The format of the RemoveImageProperty method is:</p>
332
333<pre class="code">
334 char *RemoveImageProperty(Image *image,const char *property)
335</pre>
336
337<p>A description of each parameter follows:</p></ol>
338
339<h5>image</h5>
340<ol><p>the image.</p></ol>
341
342<h5>property</h5>
343<ol><p>the image property.</p></ol>
344
345 </div>
346<h2><a href="http://www.imagemagick.org/api/MagickCore/property
347_8c.html" target="source" name="ResetImagePropertyIterator">ResetImagePropertyIterator</a></h2>
348<div class="doc-section">
349
350<p>ResetImagePropertyIterator() resets the image properties iterator. Use it in conjunction with GetNextImageProperty() to iterate over all the values associated with an image property.</p></ol>
351
352<p>The format of the ResetImagePropertyIterator method is:</p>
353
354<pre class="code">
355 ResetImagePropertyIterator(Image *image)
356</pre>
357
358<p>A description of each parameter follows:</p></ol>
359
360<h5>image</h5>
361<ol><p>the image.</p></ol>
362
363 </div>
364<h2><a href="http://www.imagemagick.org/api/MagickCore/property
365_8c.html" target="source" name="SetImageProperty">SetImageProperty</a></h2>
366<div class="doc-section">
367
368<p>SetImageProperty() associates an value with an image property.</p></ol>
369
370<p>The format of the SetImageProperty method is:</p>
371
372<pre class="code">
373 MagickBooleanType SetImageProperty(Image *image,const char *property,
374 const char *value)
375</pre>
376
377<p>A description of each parameter follows:</p></ol>
378
379<h5>image</h5>
380<ol><p>the image.</p></ol>
381
382<h5>property</h5>
383<ol><p>the image property.</p></ol>
384
385<h5>values</h5>
386<ol><p>the image property values.</p></ol>
387
388 </div>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]389
390</div>
391
392<div id="linkbar">
393 <!-- <span id="linkbar-west">&nbsp;</span> -->
394 <span id="linkbar-center">
395 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
396 <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;
cristyec678732009-09-22 11:31:10 +0000[diff] [blame]397 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristyf3bb4782009-09-08 13:10:04 +0000[diff] [blame]398 </span>
399 <span id="linkbar-east">&nbsp;</span>
400 </div>
401 <div class="footer">
402 <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>
403 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
404 </div>
405 <div style="clear: both; margin: 0; width: 100%; "></div>
406</body>
407</html>