1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
\r
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
\r
3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">
\r
5 <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
\r
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U=" />
\r
7 <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />
\r
8 <style type="text/css" media="all">
\r
9 @import url("../../www/magick.css");
\r
11 <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"/>
25 <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
26 <meta name="Distribution" content="Global"/>
29 <body id="www-imagemagick-org">
\r
30 <div class="titlebar">
\r
31 <a href="../../index.html">
\r
32 <img src="../../images/script.png" alt="[ImageMagick]"
\r
33 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
\r
34 <a href="http://www.networkredux.com">
\r
35 <img src="../../images/networkredux.png" alt="[sponsor]"
\r
36 style="margin: 45px auto; border: 0px; float: left;" /></a>
\r
37 <a href="http://www.imagemagick.org/discourse-server/">
\r
38 <img src="../../images/logo.jpg" alt=""
\r
39 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
40 <a href="../../index.html">
\r
41 <img src="../../images/sprite.jpg" alt=""
\r
42 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
\r
45 <div class="eastbar">
\r
48 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
50 <div class="sep"></div>
\r
52 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
55 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
58 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
61 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
63 <div class="sep"></div>
\r
65 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
68 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
71 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
74 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
77 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
80 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
83 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
86 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
89 <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
91 <div class="sep"></div>
\r
93 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
96 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
99 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
102 <a title="Resources" href="../../www/resources.html">Resources</a>
105 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
108 <a title="Download" href="../../www/download.html">Download</a>
110 <div class="sep"></div>
\r
112 <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
114 <div class="sep"></div>
\r
116 <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
119 <a title="Site Map: Links"href="../../www/links.html">Links</a>
121 <div class="sep"></div>
\r
123 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
125 <div class="sponsbox">
126 <div class="sponsor">
127 <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
129 <div class="sponsor">
130 <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
132 <div class="sponsor">
133 <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
135 <div class="sponsor">
136 <a title="Sponsor: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
138 <div class="sponsor">
139 <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
141 <div class="sponsor">
142 <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
152 <p class="navigation-index">[<a href="#CloneImageProperties">CloneImageProperties</a> • <a href="#DefineImageProperty">DefineImageProperty</a> • <a href="#DeleteImageProperty">DeleteImageProperty</a> • <a href="#DestroyImageProperties">DestroyImageProperties</a> • <a href="#FormatImageProperty">FormatImageProperty</a> • <a href="#GetImageProperty">GetImageProperty</a> • <a href="#GetNextImageProperty">GetNextImageProperty</a> • <a href="#InterpretImageProperties">InterpretImageProperties</a> • <a href="#RemoveImageProperty">RemoveImageProperty</a> • <a href="#ResetImagePropertyIterator">ResetImagePropertyIterator</a> • <a href="#SetImageProperty">SetImageProperty</a>]</p>
154 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
155 _8c.html" target="source" name="CloneImageProperties">CloneImageProperties</a></h2>
156 <div class="doc-section">
158 <p>CloneImageProperties() clones one or more image properties.</p></ol>
160 <p>The format of the CloneImageProperties method is:</p>
163 MagickBooleanType CloneImageProperties(Image *image,
164 const Image *clone_image)
167 <p>A description of each parameter follows:</p></ol>
170 <ol><p>the image.</p></ol>
173 <ol><p>the clone image.</p></ol>
176 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
177 _8c.html" target="source" name="DefineImageProperty">DefineImageProperty</a></h2>
178 <div class="doc-section">
180 <p>DefineImageProperty() associates a key/value pair with an image property.</p></ol>
182 <p>The format of the DefineImageProperty method is:</p>
185 MagickBooleanType DefineImageProperty(Image *image,
186 const char *property)
189 <p>A description of each parameter follows:</p></ol>
192 <ol><p>the image.</p></ol>
195 <ol><p>the image property.</p></ol>
198 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
199 _8c.html" target="source" name="DeleteImageProperty">DeleteImageProperty</a></h2>
200 <div class="doc-section">
202 <p>DeleteImageProperty() deletes an image property.</p></ol>
204 <p>The format of the DeleteImageProperty method is:</p>
207 MagickBooleanType DeleteImageProperty(Image *image,const char *property)
210 <p>A description of each parameter follows:</p></ol>
213 <ol><p>the image.</p></ol>
216 <ol><p>the image property.</p></ol>
219 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
220 _8c.html" target="source" name="DestroyImageProperties">DestroyImageProperties</a></h2>
221 <div class="doc-section">
223 <p>DestroyImageProperties() releases memory associated with image property values.</p></ol>
225 <p>The format of the DestroyDefines method is:</p>
228 void DestroyImageProperties(Image *image)
231 <p>A description of each parameter follows:</p></ol>
234 <ol><p>the image.</p></ol>
237 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
238 _8c.html" target="source" name="FormatImageProperty">FormatImageProperty</a></h2>
239 <div class="doc-section">
241 <p>FormatImageProperty() permits formatted property/value pairs to be saved as an image proporty.</p></ol>
243 <p>The format of the FormatImageProperty method is:</p>
246 MagickBooleanType FormatImageProperty(Image *image,const char *property,
247 const char *format,...)
250 <p>A description of each parameter follows.</p></ol>
253 <ol><p>The image.</p></ol>
256 <ol><p>The attribute property.</p></ol>
259 <ol><p>A string describing the format to use to write the remaining arguments.</p></ol>
262 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
263 _8c.html" target="source" name="GetImageProperty">GetImageProperty</a></h2>
264 <div class="doc-section">
266 <p>GetImageProperty() gets a value associated with an image property.</p></ol>
268 <p>The format of the GetImageProperty method is:</p>
271 const char *GetImageProperty(const Image *image,const char *key)
274 <p>A description of each parameter follows:</p></ol>
277 <ol><p>the image.</p></ol>
280 <ol><p>the key.</p></ol>
283 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
284 _8c.html" target="source" name="GetNextImageProperty">GetNextImageProperty</a></h2>
285 <div class="doc-section">
287 <p>GetNextImageProperty() gets the next image property value.</p></ol>
289 <p>The format of the GetNextImageProperty method is:</p>
292 char *GetNextImageProperty(const Image *image)
295 <p>A description of each parameter follows:</p></ol>
298 <ol><p>the image.</p></ol>
301 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
302 _8c.html" target="source" name="InterpretImageProperties">InterpretImageProperties</a></h2>
303 <div class="doc-section">
305 <p>InterpretImageProperties() replaces any embedded formatting characters with the appropriate image property and returns the interpretted text.</p></ol>
307 <p>The format of the InterpretImageProperties method is:</p>
310 char *InterpretImageProperties(const ImageInfo *image_info,Image *image,
311 const char *embed_text)
314 <p>A description of each parameter follows:</p></ol>
317 <ol><p>the image info.</p></ol>
320 <ol><p>the image.</p></ol>
323 <ol><p>the address of a character string containing the embedded formatting characters.</p></ol>
326 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
327 _8c.html" target="source" name="RemoveImageProperty">RemoveImageProperty</a></h2>
328 <div class="doc-section">
330 <p>RemoveImageProperty() removes a property from the image and returns its value.</p></ol>
332 <p>The format of the RemoveImageProperty method is:</p>
335 char *RemoveImageProperty(Image *image,const char *property)
338 <p>A description of each parameter follows:</p></ol>
341 <ol><p>the image.</p></ol>
344 <ol><p>the image property.</p></ol>
347 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
348 _8c.html" target="source" name="ResetImagePropertyIterator">ResetImagePropertyIterator</a></h2>
349 <div class="doc-section">
351 <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>
353 <p>The format of the ResetImagePropertyIterator method is:</p>
356 ResetImagePropertyIterator(Image *image)
359 <p>A description of each parameter follows:</p></ol>
362 <ol><p>the image.</p></ol>
365 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
366 _8c.html" target="source" name="SetImageProperty">SetImageProperty</a></h2>
367 <div class="doc-section">
369 <p>SetImageProperty() associates an value with an image property.</p></ol>
371 <p>The format of the SetImageProperty method is:</p>
374 MagickBooleanType SetImageProperty(Image *image,const char *property,
378 <p>A description of each parameter follows:</p></ol>
381 <ol><p>the image.</p></ol>
384 <ol><p>the image property.</p></ol>
387 <ol><p>the image property values.</p></ol>
394 <!-- <span id="linkbar-west"> </span> -->
\r
395 <span id="linkbar-center">
\r
396 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> •
\r
397 <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
\r
399 <span id="linkbar-east"> </span>
\r
401 <div class="footer">
\r
402 <span id="footer-west">© 1999-2010 ImageMagick Studio LLC</span>
\r
403 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
\r
405 <div style="clear: both; margin: 0; width: 100%; "></div>
\r