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