source: ImageMagick/trunk/www/api/property.html @ 4019

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