Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / ImageMagick / e6529ff52c05a2d3352d83a429cb69aa15f5b585 / . / www / api / property.html
blob: 2741611c85c4f4228f9560d698096f2f2e781292 [file] [log] [blame]
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
2 "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" dir="ltr">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]4<head>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]5 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
6 <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]7 <title>ImageMagick: MagickCore, C API for ImageMagick: Get/Set Image Properties</title>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]8 <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 +0000[diff] [blame]11 <meta name="Application-name" content="ImageMagick"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]12 <meta name="Description" content="ImageMagick is a software suite to create, edit, compose, or convert bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]13 <meta name="Application-url" content="http://www.imagemagick.org"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]14 <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 +0000[diff] [blame]16 <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 +0000[diff] [blame]22 <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]23 <meta name="Distribution" content="Global"/>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]24 <link rel="icon" href="../../images/wand.png"/>
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]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"/>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]27 <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />
cristy3c98a4f2010-08-13 20:09:41 +0000[diff] [blame]28 <style type="text/css" media="all">
29 @import url("../../www/magick.css");
30 </style>
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]31 <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>
cristy361f4662010-12-31 23:02:52 +0000[diff] [blame]32 <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>
33 <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />
34 <script type="text/javascript">
35 $(document).ready(function() {
36 $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({
37 'transitionIn' : 'elastic',
38 'transitionOut' : 'elastic',
39 'overlayShow' : false,
40 'opacity' : true
41 });
42 });
43 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]44</head>
45
46<body id="www-imagemagick-org">
47<div class="titlebar">
48<a href="../../index.html">
49 <img src="../../images/script.png" alt="[ImageMagick]"
50 style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>
51<a href="http://www.networkredux.com">
52 <img src="../../images/networkredux.png" alt="[sponsor]"
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]53 style="margin-top: 42px; border: 0px; float: left;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]54<a href="http://www.imagemagick.org/discourse-server/">
55 <img src="../../images/logo.jpg" alt=""
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]56 style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]57<a href="../../index.html">
58 <img src="../../images/sprite.jpg" alt=""
59 style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
60</div>
61
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]62<div class="westbar">
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]63
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]64<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]65 <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]66</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]67<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]68<div class="menu">
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]69 <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
70</div>
71<div class="sub">
72 <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
73</div>
74<div class="sub">
75 <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
76</div>
77<div class="sub">
78 <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
79</div>
80<div class="sep"></div>
81<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]82 <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]83</div>
84<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]85 <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]86</div>
87<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]88 <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]89</div>
90<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]91 <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]92</div>
93<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]94 <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]95</div>
96<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]97 <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]98</div>
99<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]100 <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]101</div>
102<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]103 <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]104</div>
105<div class="sub">
cristydcca3fa2010-12-29 21:50:07 +0000[diff] [blame]106 <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]107</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]108<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]109<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]110 <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]111</div>
112<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]113 <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]114</div>
115<div class="sub">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]116 <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]117 </div>
118<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]119 <a title="Resources" href="../../www/resources.html">Resources</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]120</div>
cristybb503372010-05-27 20:51:26 +0000[diff] [blame]121<div class="menu">
122 <a title="Architecture" href="../../www/architecture.html">Architecture</a>
123</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]124<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]125 <a title="Download" href="../../www/download.html">Download</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]126</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]127<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]128<div class="menu">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]129 <a title="Search" href="../../www/search.html">Search</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]130</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]131<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]132<div class="menu">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]133 <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]134</div>
135<div class="sub">
cristyffb69ed2010-12-25 00:06:48 +0000[diff] [blame]136 <a title="Site Map: Links" href="../../www/links.html">Links</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]137</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]138<div class="sep"></div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]139<div class="menu">
cristy83a272e2010-05-07 20:40:35 +0000[diff] [blame]140 <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]141
142<div class="sponsbox">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]143<div class="sponsor">
144 <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201106010240 -->
145</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]146<div class="sponsor">
cristy52923442011-01-15 22:54:31 +0000[diff] [blame]147 <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
cristy5c4585b2010-11-11 00:13:57 +0000[diff] [blame]148</div>
149<div class="sponsor">
cristyc5baf4f2010-08-31 15:05:33 +0000[diff] [blame]150 <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
151</div>
152<div class="sponsor">
cristy851dbce2010-08-06 21:40:00 +0000[diff] [blame]153 <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
154</div>
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]155<div class="sponsor">
cristy178edaf2011-01-23 03:42:39 +0000[diff] [blame]156 <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
157</div>
158<div class="sponsor">
cristyf7964272011-01-30 03:49:12 +0000[diff] [blame]159 <a title="Sponsor: Notebook Reparatur Berlin" href="http://www.notebook-reparaturen-berlin.de">Notebook Reparatur Berlin</a><!-- 2011050100025 gabi.schulze-->
cristyec6b4752011-01-08 03:16:23 +0000[diff] [blame]160</div>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]161</div>
162</div>
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]163</div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]164
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]165<div class="eastbar">
166 <script type="text/javascript">
167 <!--
168 google_ad_client = "pub-3129977114552745";
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]169 google_ad_slot = "0574824969";
170 google_ad_width = 160;
171 google_ad_height = 600;
172 //-->
173 </script>
174 <script type="text/javascript"
175 src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
176 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]177</div>
178
179<div class="main">
180
cristy307ba182010-12-25 01:00:34 +0000[diff] [blame]181<h1>Module property
182 Methods</h1>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]183<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>
184
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]185<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/property
186_8c.html" id="CloneImageProperties">CloneImageProperties</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]187<div class="doc-section">
188
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]189<p>CloneImageProperties() clones one or more image properties.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]190
191<p>The format of the CloneImageProperties method is:</p>
192
193<pre class="code">
194 MagickBooleanType CloneImageProperties(Image *image,
195 const Image *clone_image)
196</pre>
197
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]198<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]199
200<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]201<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]202
203<h5>clone_image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]204<p>the clone image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]205
206 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]207<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/property
208_8c.html" id="DefineImageProperty">DefineImageProperty</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]209<div class="doc-section">
210
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]211<p>DefineImageProperty() associates a key/value pair with an image property.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]212
213<p>The format of the DefineImageProperty method is:</p>
214
215<pre class="code">
216 MagickBooleanType DefineImageProperty(Image *image,
217 const char *property)
218</pre>
219
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]220<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]221
222<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]223<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]224
225<h5>property</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]226<p>the image property.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]227
228 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]229<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/property
230_8c.html" id="DeleteImageProperty">DeleteImageProperty</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]231<div class="doc-section">
232
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]233<p>DeleteImageProperty() deletes an image property.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]234
235<p>The format of the DeleteImageProperty method is:</p>
236
237<pre class="code">
238 MagickBooleanType DeleteImageProperty(Image *image,const char *property)
239</pre>
240
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]241<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]242
243<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]244<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]245
246<h5>property</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]247<p>the image property.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]248
249 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]250<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/property
251_8c.html" id="DestroyImageProperties">DestroyImageProperties</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]252<div class="doc-section">
253
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]254<p>DestroyImageProperties() releases memory associated with image property values.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]255
256<p>The format of the DestroyDefines method is:</p>
257
258<pre class="code">
259 void DestroyImageProperties(Image *image)
260</pre>
261
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]262<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]263
264<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]265<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]266
267 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]268<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/property
269_8c.html" id="FormatImageProperty">FormatImageProperty</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]270<div class="doc-section">
271
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]272<p>FormatImageProperty() permits formatted property/value pairs to be saved as an image property.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]273
274<p>The format of the FormatImageProperty method is:</p>
275
276<pre class="code">
277 MagickBooleanType FormatImageProperty(Image *image,const char *property,
278 const char *format,...)
279</pre>
280
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]281<p>A description of each parameter follows.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]282
283<h5> image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]284<p>The image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]285
286<h5> property</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]287<p>The attribute property.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]288
289<h5> format</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]290<p>A string describing the format to use to write the remaining arguments.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]291
292 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]293<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/property
294_8c.html" id="GetImageProperty">GetImageProperty</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]295<div class="doc-section">
296
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]297<p>GetImageProperty() gets a value associated with an image property.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]298
299<p>The format of the GetImageProperty method is:</p>
300
301<pre class="code">
302 const char *GetImageProperty(const Image *image,const char *key)
303</pre>
304
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]305<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]306
307<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]308<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]309
310<h5>key</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]311<p>the key.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]312
313 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]314<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/property
315_8c.html" id="GetNextImageProperty">GetNextImageProperty</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]316<div class="doc-section">
317
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]318<p>GetNextImageProperty() gets the next image property value.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]319
320<p>The format of the GetNextImageProperty method is:</p>
321
322<pre class="code">
323 char *GetNextImageProperty(const Image *image)
324</pre>
325
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]326<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]327
328<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]329<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]330
331 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]332<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/property
333_8c.html" id="InterpretImageProperties">InterpretImageProperties</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]334<div class="doc-section">
335
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]336<p>InterpretImageProperties() replaces any embedded formatting characters with the appropriate image property and returns the interpretted text.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]337
338<p>The format of the InterpretImageProperties method is:</p>
339
340<pre class="code">
341 char *InterpretImageProperties(const ImageInfo *image_info,Image *image,
342 const char *embed_text)
343</pre>
344
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]345<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]346
347<h5>image_info</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]348<p>the image info.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]349
350<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]351<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]352
353<h5>embed_text</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]354<p>the address of a character string containing the embedded formatting characters.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]355
356 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]357<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/property
358_8c.html" id="RemoveImageProperty">RemoveImageProperty</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]359<div class="doc-section">
360
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]361<p>RemoveImageProperty() removes a property from the image and returns its value.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]362
363<p>The format of the RemoveImageProperty method is:</p>
364
365<pre class="code">
366 char *RemoveImageProperty(Image *image,const char *property)
367</pre>
368
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]369<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]370
371<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]372<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]373
374<h5>property</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]375<p>the image property.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]376
377 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]378<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/property
379_8c.html" id="ResetImagePropertyIterator">ResetImagePropertyIterator</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]380<div class="doc-section">
381
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]382<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>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]383
384<p>The format of the ResetImagePropertyIterator method is:</p>
385
386<pre class="code">
387 ResetImagePropertyIterator(Image *image)
388</pre>
389
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]390<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]391
392<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]393<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]394
395 </div>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]396<h2><a href="http://www.wizards-toolkit.org/api/MagickCore/property
397_8c.html" id="SetImageProperty">SetImageProperty</a></h2>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]398<div class="doc-section">
399
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]400<p>SetImageProperty() associates an value with an image property.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]401
402<p>The format of the SetImageProperty method is:</p>
403
404<pre class="code">
405 MagickBooleanType SetImageProperty(Image *image,const char *property,
406 const char *value)
407</pre>
408
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]409<p>A description of each parameter follows:</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]410
411<h5>image</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]412<p>the image.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]413
414<h5>property</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]415<p>the image property.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]416
417<h5>values</h5>
cristy7a40ba82011-01-08 20:31:18 +0000[diff] [blame]418<p>the image property values.</p>
cristy3ed852e2009-09-05 21:47:34 +0000[diff] [blame]419
420 </div>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]421
422</div>
423
424<div id="linkbar">
cristyce69bb02010-07-27 19:49:46 +0000[diff] [blame]425 <span id="linkbar-west">&nbsp;</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]426 <span id="linkbar-center">
427 <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]428 <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]429 </span>
430 <span id="linkbar-east">&nbsp;</span>
431 </div>
432 <div class="footer">
cristy4103d562010-12-10 01:38:54 +0000[diff] [blame]433 <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]434 <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>
435 </div>
436 <div style="clear: both; margin: 0; width: 100%; "></div>
cristya8902942010-07-30 00:49:52 +0000[diff] [blame]437 <script type="text/javascript">
438 var _gaq = _gaq || [];
439 _gaq.push(['_setAccount', 'UA-17690367-1']);
440 _gaq.push(['_trackPageview']);
441
442 (function() {
443 var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
444 ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
445 var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
446 })();
447 </script>
cristy3eaa0ef2010-03-06 20:35:26 +0000[diff] [blame]448</body>
449</html>