blob: fc2a25c3ff7afc904522ea0cc0f6ccc9108ec79a [file] [log] [blame]
cristy3eaa0ef2010-03-06 20:35:26 +00001<!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 +00003<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +00004<head>
cristy3c98a4f2010-08-13 20:09:41 +00005 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +00007 <title>ImageMagick: MagickCore, C API for ImageMagick: Get/Set Image Properties</title>
cristy3ed852e2009-09-05 21:47:34 +00008 <meta http-equiv="Content-Language" content="en-US"/>
9 <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
10 <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
cristy3c98a4f2010-08-13 20:09:41 +000011 <meta name="Application-name" content="ImageMagick"/>
cristyffb69ed2010-12-25 00:06:48 +000012 <meta name="Description" content="ImageMagick is a software suite to create, edit, or compose bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +000013 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +000014 <meta name="Generator" content="PHP"/>
15 <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"/>
cristy3ed852e2009-09-05 21:47:34 +000016 <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"/>
cristy4103d562010-12-10 01:38:54 +000022 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000023 <meta name="Distribution" content="Global"/>
cristy3c98a4f2010-08-13 20:09:41 +000024 <link rel="icon" href="../../images/wand.png" sizes="32x32"/>
25 <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/>
26 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
27 <style type="text/css" media="all">
28 @import url("../../www/magick.css");
29 </style>
cristy3eaa0ef2010-03-06 20:35:26 +000030</head>
31
32<body id="www-imagemagick-org">
33<div class="titlebar">
34<a href="../../index.html">
35 <img src="../../images/script.png" alt="[ImageMagick]"
36 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
37<a href="http://www.networkredux.com">
38 <img src="../../images/networkredux.png" alt="[sponsor]"
39 style="margin: 45px auto; border: 0px; float: left;" /></a>
40<a href="http://www.imagemagick.org/discourse-server/">
41 <img src="../../images/logo.jpg" alt=""
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
43<a href="../../index.html">
44 <img src="../../images/sprite.jpg" alt=""
45 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
46</div>
47
cristyce69bb02010-07-27 19:49:46 +000048<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000049
cristy3ed852e2009-09-05 21:47:34 +000050<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000051 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000052</div>
cristy3eaa0ef2010-03-06 20:35:26 +000053<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000054<div class="menu">
cristybb503372010-05-27 20:51:26 +000055 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
56</div>
57<div class="sub">
58 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
59</div>
60<div class="sub">
61 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
62</div>
63<div class="sub">
64 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
65</div>
66<div class="sep"></div>
67<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000068 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000069</div>
70<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000071 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +000072</div>
73<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000074 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +000075</div>
76<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000077 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000078</div>
79<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000080 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000081</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000083 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +000084</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000086 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +000087</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000089 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000090</div>
91<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000092 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +000093</div>
cristy3eaa0ef2010-03-06 20:35:26 +000094<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000095<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000096 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +000097</div>
98<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000099 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000100</div>
101<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000102 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000103 </div>
104<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000105 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000106</div>
cristybb503372010-05-27 20:51:26 +0000107<div class="menu">
108 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
109</div>
cristy3ed852e2009-09-05 21:47:34 +0000110<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000111 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000112</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000113<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000114<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000115 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000116</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000117<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000118<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000119 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000120</div>
121<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000122 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000123</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000124<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000125<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000126 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000127
128<div class="sponsbox">
129<div class="sponsor">
cristyffb69ed2010-12-25 00:06:48 +0000130 <a title="Sponsor: Fernsehdienst Berlin" href="http://www.atlas-multimedia.de">Fernsehdienst Berlin</a><!-- 2011040100025 atlas.multimedia-->
cristy5c4585b2010-11-11 00:13:57 +0000131</div>
132<div class="sponsor">
cristy7d52cd62010-10-01 17:26:59 +0000133 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
cristy73fd1cd2010-09-12 19:14:25 +0000134</div>
135<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000136 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
137</div>
138<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000139 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
140</div>
141<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000142 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy69e3f922010-04-10 14:20:03 +0000143</div>
144<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000145 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000146</div>
147<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000148 <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
cristy916e1922009-10-01 12:52:47 +0000149</div>
cristy3ed852e2009-09-05 21:47:34 +0000150</div>
151</div>
cristyce69bb02010-07-27 19:49:46 +0000152</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000153
cristyce69bb02010-07-27 19:49:46 +0000154<div class="eastbar">
155 <script type="text/javascript">
156 <!--
157 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000158 google_ad_slot = "0574824969";
159 google_ad_width = 160;
160 google_ad_height = 600;
161 //-->
162 </script>
163 <script type="text/javascript"
164 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
165 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000166</div>
167
168<div class="main">
169
cristy3ed852e2009-09-05 21:47:34 +0000170<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>
171
172<h2><a href="http://www.imagemagick.org/api/MagickCore/property
173_8c.html" target="source" name="CloneImageProperties">CloneImageProperties</a></h2>
174<div class="doc-section">
175
176<p>CloneImageProperties() clones one or more image properties.</p></ol>
177
178<p>The format of the CloneImageProperties method is:</p>
179
180<pre class="code">
181 MagickBooleanType CloneImageProperties(Image *image,
182 const Image *clone_image)
183</pre>
184
185<p>A description of each parameter follows:</p></ol>
186
187<h5>image</h5>
188<ol><p>the image.</p></ol>
189
190<h5>clone_image</h5>
191<ol><p>the clone image.</p></ol>
192
193 </div>
194<h2><a href="http://www.imagemagick.org/api/MagickCore/property
195_8c.html" target="source" name="DefineImageProperty">DefineImageProperty</a></h2>
196<div class="doc-section">
197
198<p>DefineImageProperty() associates a key/value pair with an image property.</p></ol>
199
200<p>The format of the DefineImageProperty method is:</p>
201
202<pre class="code">
203 MagickBooleanType DefineImageProperty(Image *image,
204 const char *property)
205</pre>
206
207<p>A description of each parameter follows:</p></ol>
208
209<h5>image</h5>
210<ol><p>the image.</p></ol>
211
212<h5>property</h5>
213<ol><p>the image property.</p></ol>
214
215 </div>
216<h2><a href="http://www.imagemagick.org/api/MagickCore/property
217_8c.html" target="source" name="DeleteImageProperty">DeleteImageProperty</a></h2>
218<div class="doc-section">
219
220<p>DeleteImageProperty() deletes an image property.</p></ol>
221
222<p>The format of the DeleteImageProperty method is:</p>
223
224<pre class="code">
225 MagickBooleanType DeleteImageProperty(Image *image,const char *property)
226</pre>
227
228<p>A description of each parameter follows:</p></ol>
229
230<h5>image</h5>
231<ol><p>the image.</p></ol>
232
233<h5>property</h5>
234<ol><p>the image property.</p></ol>
235
236 </div>
237<h2><a href="http://www.imagemagick.org/api/MagickCore/property
238_8c.html" target="source" name="DestroyImageProperties">DestroyImageProperties</a></h2>
239<div class="doc-section">
240
241<p>DestroyImageProperties() releases memory associated with image property values.</p></ol>
242
243<p>The format of the DestroyDefines method is:</p>
244
245<pre class="code">
246 void DestroyImageProperties(Image *image)
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 </div>
255<h2><a href="http://www.imagemagick.org/api/MagickCore/property
256_8c.html" target="source" name="FormatImageProperty">FormatImageProperty</a></h2>
257<div class="doc-section">
258
cristyffb69ed2010-12-25 00:06:48 +0000259<p>FormatImageProperty() permits formatted property/value pairs to be saved as an image property.</p></ol>
cristy3ed852e2009-09-05 21:47:34 +0000260
261<p>The format of the FormatImageProperty method is:</p>
262
263<pre class="code">
264 MagickBooleanType FormatImageProperty(Image *image,const char *property,
265 const char *format,...)
266</pre>
267
268<p>A description of each parameter follows.</p></ol>
269
270<h5> image</h5>
271<ol><p>The image.</p></ol>
272
273<h5> property</h5>
274<ol><p>The attribute property.</p></ol>
275
276<h5> format</h5>
277<ol><p>A string describing the format to use to write the remaining arguments.</p></ol>
278
279 </div>
280<h2><a href="http://www.imagemagick.org/api/MagickCore/property
281_8c.html" target="source" name="GetImageProperty">GetImageProperty</a></h2>
282<div class="doc-section">
283
284<p>GetImageProperty() gets a value associated with an image property.</p></ol>
285
286<p>The format of the GetImageProperty method is:</p>
287
288<pre class="code">
289 const char *GetImageProperty(const Image *image,const char *key)
290</pre>
291
292<p>A description of each parameter follows:</p></ol>
293
294<h5>image</h5>
295<ol><p>the image.</p></ol>
296
297<h5>key</h5>
298<ol><p>the key.</p></ol>
299
300 </div>
301<h2><a href="http://www.imagemagick.org/api/MagickCore/property
302_8c.html" target="source" name="GetNextImageProperty">GetNextImageProperty</a></h2>
303<div class="doc-section">
304
305<p>GetNextImageProperty() gets the next image property value.</p></ol>
306
307<p>The format of the GetNextImageProperty method is:</p>
308
309<pre class="code">
310 char *GetNextImageProperty(const Image *image)
311</pre>
312
313<p>A description of each parameter follows:</p></ol>
314
315<h5>image</h5>
316<ol><p>the image.</p></ol>
317
318 </div>
319<h2><a href="http://www.imagemagick.org/api/MagickCore/property
320_8c.html" target="source" name="InterpretImageProperties">InterpretImageProperties</a></h2>
321<div class="doc-section">
322
323<p>InterpretImageProperties() replaces any embedded formatting characters with the appropriate image property and returns the interpretted text.</p></ol>
324
325<p>The format of the InterpretImageProperties method is:</p>
326
327<pre class="code">
328 char *InterpretImageProperties(const ImageInfo *image_info,Image *image,
329 const char *embed_text)
330</pre>
331
332<p>A description of each parameter follows:</p></ol>
333
334<h5>image_info</h5>
335<ol><p>the image info.</p></ol>
336
337<h5>image</h5>
338<ol><p>the image.</p></ol>
339
340<h5>embed_text</h5>
341<ol><p>the address of a character string containing the embedded formatting characters.</p></ol>
342
343 </div>
344<h2><a href="http://www.imagemagick.org/api/MagickCore/property
345_8c.html" target="source" name="RemoveImageProperty">RemoveImageProperty</a></h2>
346<div class="doc-section">
347
348<p>RemoveImageProperty() removes a property from the image and returns its value.</p></ol>
349
350<p>The format of the RemoveImageProperty method is:</p>
351
352<pre class="code">
353 char *RemoveImageProperty(Image *image,const char *property)
354</pre>
355
356<p>A description of each parameter follows:</p></ol>
357
358<h5>image</h5>
359<ol><p>the image.</p></ol>
360
361<h5>property</h5>
362<ol><p>the image property.</p></ol>
363
364 </div>
365<h2><a href="http://www.imagemagick.org/api/MagickCore/property
366_8c.html" target="source" name="ResetImagePropertyIterator">ResetImagePropertyIterator</a></h2>
367<div class="doc-section">
368
369<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>
370
371<p>The format of the ResetImagePropertyIterator method is:</p>
372
373<pre class="code">
374 ResetImagePropertyIterator(Image *image)
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 </div>
383<h2><a href="http://www.imagemagick.org/api/MagickCore/property
384_8c.html" target="source" name="SetImageProperty">SetImageProperty</a></h2>
385<div class="doc-section">
386
387<p>SetImageProperty() associates an value with an image property.</p></ol>
388
389<p>The format of the SetImageProperty method is:</p>
390
391<pre class="code">
392 MagickBooleanType SetImageProperty(Image *image,const char *property,
393 const char *value)
394</pre>
395
396<p>A description of each parameter follows:</p></ol>
397
398<h5>image</h5>
399<ol><p>the image.</p></ol>
400
401<h5>property</h5>
402<ol><p>the image property.</p></ol>
403
404<h5>values</h5>
405<ol><p>the image property values.</p></ol>
406
407 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000408
409</div>
410
411<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000412 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000413 <span id="linkbar-center">
414 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000415 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000416 </span>
417 <span id="linkbar-east">&nbsp;</span>
418 </div>
419 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000420 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000421 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
422 </div>
423 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000424 <script type="text/javascript">
425 var _gaq = _gaq || [];
426 _gaq.push(['_setAccount', 'UA-17690367-1']);
427 _gaq.push(['_trackPageview']);
428
429 (function() {
430 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
431 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
432 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
433 })();
434 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000435</body>
436</html>