granicus.if.org Git - imagemagick/blob - www/api/property.html

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