blob: 9243358cda70122ef05a4036198478ebbdf7fea4 [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>
cristy3de29cc2010-04-15 02:34:44 +00005 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
cristy3eaa0ef2010-03-06 20:35:26 +00006 <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 +00008 <style type="text/css" media="all">
cristy3eaa0ef2010-03-06 20:35:26 +00009 @import url("../../www/magick.css");
cristy3de29cc2010-04-15 02:34:44 +000010 </style>
cristy3ed852e2009-09-05 21:47:34 +000011 <link rel="shortcut icon" href="../../images/wand.ico" type="images/vnd.microsoft.icon"/>
12 <title>ImageMagick: MagickCore, C API for ImageMagick: Get/Set Image Properties</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:, get/set, image, properties, 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 +000025 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +000026 <meta name="Distribution" content="Global"/>
cristy3eaa0ef2010-03-06 20:35:26 +000027</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 +000045<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +000046
cristy3ed852e2009-09-05 21:47:34 +000047<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000048 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000049</div>
cristy3eaa0ef2010-03-06 20:35:26 +000050<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000051<div class="menu">
cristybb503372010-05-27 20:51:26 +000052 <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 +000065 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +000066</div>
67<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000068 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</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: Options" href="../../www/command-line-options.html">Options</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: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +000075</div>
76<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000077 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +000078</div>
79<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000080 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +000081</div>
82<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000083 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +000084</div>
85<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000086 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +000087</div>
88<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000089 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +000090</div>
cristy3eaa0ef2010-03-06 20:35:26 +000091<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +000092<div class="menu">
cristy83a272e2010-05-07 20:40:35 +000093 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +000094</div>
95<div class="sub">
cristy83a272e2010-05-07 20:40:35 +000096 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</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: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000100 </div>
101<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000102 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000103</div>
cristybb503372010-05-27 20:51:26 +0000104<div class="menu">
105 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
106</div>
cristy3ed852e2009-09-05 21:47:34 +0000107<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000108 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000109</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000110<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000111<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000112 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000113</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000114<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000115<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000116 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000117</div>
118<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000119 <a title="Site Map: Links"href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000120</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000121<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000122<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000123 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000124
125<div class="sponsbox">
126<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000127 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
cristy69e3f922010-04-10 14:20:03 +0000128</div>
129<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000130 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
cristy8f900122010-03-05 15:26:31 +0000131</div>
132<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000133 <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
cristycd1da082009-11-11 02:24:40 +0000134</div>
135<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000136 <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
cristy916e1922009-10-01 12:52:47 +0000137</div>
138<div class="sponsor">
cristy83a272e2010-05-07 20:40:35 +0000139 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
cristyb4c03bb2009-09-27 13:55:46 +0000140</div>
cristy10c87152010-06-26 16:12:21 +0000141<div class="sponsor">
cristyce69bb02010-07-27 19:49:46 +0000142 <a title="Sponsor: Webdesign" href="http://www.renehornig.com/">Webdesign</a><!-- 20111001000240 -->
cristy10c87152010-06-26 16:12:21 +0000143</div>
cristy3ed852e2009-09-05 21:47:34 +0000144</div>
145</div>
cristyce69bb02010-07-27 19:49:46 +0000146</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000147
cristyce69bb02010-07-27 19:49:46 +0000148<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 +0000161</div>
162
163<div class="main">
164
cristy3ed852e2009-09-05 21:47:34 +0000165<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>
166
167<h2><a href="http://www.imagemagick.org/api/MagickCore/property
168_8c.html" target="source" name="CloneImageProperties">CloneImageProperties</a></h2>
169<div class="doc-section">
170
171<p>CloneImageProperties() clones one or more image properties.</p></ol>
172
173<p>The format of the CloneImageProperties method is:</p>
174
175<pre class="code">
176 MagickBooleanType CloneImageProperties(Image *image,
177 const Image *clone_image)
178</pre>
179
180<p>A description of each parameter follows:</p></ol>
181
182<h5>image</h5>
183<ol><p>the image.</p></ol>
184
185<h5>clone_image</h5>
186<ol><p>the clone image.</p></ol>
187
188 </div>
189<h2><a href="http://www.imagemagick.org/api/MagickCore/property
190_8c.html" target="source" name="DefineImageProperty">DefineImageProperty</a></h2>
191<div class="doc-section">
192
193<p>DefineImageProperty() associates a key/value pair with an image property.</p></ol>
194
195<p>The format of the DefineImageProperty method is:</p>
196
197<pre class="code">
198 MagickBooleanType DefineImageProperty(Image *image,
199 const char *property)
200</pre>
201
202<p>A description of each parameter follows:</p></ol>
203
204<h5>image</h5>
205<ol><p>the image.</p></ol>
206
207<h5>property</h5>
208<ol><p>the image property.</p></ol>
209
210 </div>
211<h2><a href="http://www.imagemagick.org/api/MagickCore/property
212_8c.html" target="source" name="DeleteImageProperty">DeleteImageProperty</a></h2>
213<div class="doc-section">
214
215<p>DeleteImageProperty() deletes an image property.</p></ol>
216
217<p>The format of the DeleteImageProperty method is:</p>
218
219<pre class="code">
220 MagickBooleanType DeleteImageProperty(Image *image,const char *property)
221</pre>
222
223<p>A description of each parameter follows:</p></ol>
224
225<h5>image</h5>
226<ol><p>the image.</p></ol>
227
228<h5>property</h5>
229<ol><p>the image property.</p></ol>
230
231 </div>
232<h2><a href="http://www.imagemagick.org/api/MagickCore/property
233_8c.html" target="source" name="DestroyImageProperties">DestroyImageProperties</a></h2>
234<div class="doc-section">
235
236<p>DestroyImageProperties() releases memory associated with image property values.</p></ol>
237
238<p>The format of the DestroyDefines method is:</p>
239
240<pre class="code">
241 void DestroyImageProperties(Image *image)
242</pre>
243
244<p>A description of each parameter follows:</p></ol>
245
246<h5>image</h5>
247<ol><p>the image.</p></ol>
248
249 </div>
250<h2><a href="http://www.imagemagick.org/api/MagickCore/property
251_8c.html" target="source" name="FormatImageProperty">FormatImageProperty</a></h2>
252<div class="doc-section">
253
254<p>FormatImageProperty() permits formatted property/value pairs to be saved as an image proporty.</p></ol>
255
256<p>The format of the FormatImageProperty method is:</p>
257
258<pre class="code">
259 MagickBooleanType FormatImageProperty(Image *image,const char *property,
260 const char *format,...)
261</pre>
262
263<p>A description of each parameter follows.</p></ol>
264
265<h5> image</h5>
266<ol><p>The image.</p></ol>
267
268<h5> property</h5>
269<ol><p>The attribute property.</p></ol>
270
271<h5> format</h5>
272<ol><p>A string describing the format to use to write the remaining arguments.</p></ol>
273
274 </div>
275<h2><a href="http://www.imagemagick.org/api/MagickCore/property
276_8c.html" target="source" name="GetImageProperty">GetImageProperty</a></h2>
277<div class="doc-section">
278
279<p>GetImageProperty() gets a value associated with an image property.</p></ol>
280
281<p>The format of the GetImageProperty method is:</p>
282
283<pre class="code">
284 const char *GetImageProperty(const Image *image,const char *key)
285</pre>
286
287<p>A description of each parameter follows:</p></ol>
288
289<h5>image</h5>
290<ol><p>the image.</p></ol>
291
292<h5>key</h5>
293<ol><p>the key.</p></ol>
294
295 </div>
296<h2><a href="http://www.imagemagick.org/api/MagickCore/property
297_8c.html" target="source" name="GetNextImageProperty">GetNextImageProperty</a></h2>
298<div class="doc-section">
299
300<p>GetNextImageProperty() gets the next image property value.</p></ol>
301
302<p>The format of the GetNextImageProperty method is:</p>
303
304<pre class="code">
305 char *GetNextImageProperty(const Image *image)
306</pre>
307
308<p>A description of each parameter follows:</p></ol>
309
310<h5>image</h5>
311<ol><p>the image.</p></ol>
312
313 </div>
314<h2><a href="http://www.imagemagick.org/api/MagickCore/property
315_8c.html" target="source" name="InterpretImageProperties">InterpretImageProperties</a></h2>
316<div class="doc-section">
317
318<p>InterpretImageProperties() replaces any embedded formatting characters with the appropriate image property and returns the interpretted text.</p></ol>
319
320<p>The format of the InterpretImageProperties method is:</p>
321
322<pre class="code">
323 char *InterpretImageProperties(const ImageInfo *image_info,Image *image,
324 const char *embed_text)
325</pre>
326
327<p>A description of each parameter follows:</p></ol>
328
329<h5>image_info</h5>
330<ol><p>the image info.</p></ol>
331
332<h5>image</h5>
333<ol><p>the image.</p></ol>
334
335<h5>embed_text</h5>
336<ol><p>the address of a character string containing the embedded formatting characters.</p></ol>
337
338 </div>
339<h2><a href="http://www.imagemagick.org/api/MagickCore/property
340_8c.html" target="source" name="RemoveImageProperty">RemoveImageProperty</a></h2>
341<div class="doc-section">
342
343<p>RemoveImageProperty() removes a property from the image and returns its value.</p></ol>
344
345<p>The format of the RemoveImageProperty method is:</p>
346
347<pre class="code">
348 char *RemoveImageProperty(Image *image,const char *property)
349</pre>
350
351<p>A description of each parameter follows:</p></ol>
352
353<h5>image</h5>
354<ol><p>the image.</p></ol>
355
356<h5>property</h5>
357<ol><p>the image property.</p></ol>
358
359 </div>
360<h2><a href="http://www.imagemagick.org/api/MagickCore/property
361_8c.html" target="source" name="ResetImagePropertyIterator">ResetImagePropertyIterator</a></h2>
362<div class="doc-section">
363
364<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>
365
366<p>The format of the ResetImagePropertyIterator method is:</p>
367
368<pre class="code">
369 ResetImagePropertyIterator(Image *image)
370</pre>
371
372<p>A description of each parameter follows:</p></ol>
373
374<h5>image</h5>
375<ol><p>the image.</p></ol>
376
377 </div>
378<h2><a href="http://www.imagemagick.org/api/MagickCore/property
379_8c.html" target="source" name="SetImageProperty">SetImageProperty</a></h2>
380<div class="doc-section">
381
382<p>SetImageProperty() associates an value with an image property.</p></ol>
383
384<p>The format of the SetImageProperty method is:</p>
385
386<pre class="code">
387 MagickBooleanType SetImageProperty(Image *image,const char *property,
388 const char *value)
389</pre>
390
391<p>A description of each parameter follows:</p></ol>
392
393<h5>image</h5>
394<ol><p>the image.</p></ol>
395
396<h5>property</h5>
397<ol><p>the image property.</p></ol>
398
399<h5>values</h5>
400<ol><p>the image property values.</p></ol>
401
402 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000403
404</div>
405
406<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000407 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000408 <span id="linkbar-center">
409 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristyce69bb02010-07-27 19:49:46 +0000410 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000411 </span>
412 <span id="linkbar-east">&nbsp;</span>
413 </div>
414 <div class="footer">
415 <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>
416 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
417 </div>
418 <div style="clear: both; margin: 0; width: 100%; "></div>
419</body>
420</html>