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: Free Catalogs" href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 20120801000600 -->
 131 </div>
 132 <div  class="sponsor">
 133   <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
 134 </div>
 135 <div  class="sponsor">
 136   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 137 </div>
 138 <div  class="sponsor">
 139   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 140 </div>
 141 <div  class="sponsor">
 142   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 143 </div>
 144 <div  class="sponsor">
 145   <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
 146 </div>
 147 <div  class="sponsor">
 148    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 149 </div>
 150 </div>
 151 </div>
 152 </div>\r
 153 \r
 154 <div class="eastbar">\r
 155   <script type="text/javascript">\r
 156   <!--\r
 157     google_ad_client = "pub-3129977114552745";\r
 158     google_ad_slot = "0574824969";\r
 159     google_ad_width = 160;\r
 160     google_ad_height = 600;\r
 161   //-->\r
 162   </script>\r
 163   <script type="text/javascript"\r
 164     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 165   </script>\r
 166 </div>\r
 167 \r
 168 <div class="main">\r
 169 \r
 170 <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>
 171
 172 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 173 _8c.html" target="source" name="CloneImageProperties">CloneImageProperties</a></h2>
 174 <div class="doc-section">
 175
 176 <p>CloneImageProperties() clones one or more image properties.</p></ol>
 177
 178 <p>The format of the CloneImageProperties method is:</p>
 179
 180 <pre class="code">
 181   MagickBooleanType CloneImageProperties(Image *image,
 182     const Image *clone_image)
 183 </pre>
 184
 185 <p>A description of each parameter follows:</p></ol>
 186
 187 <h5>image</h5>
 188 <ol><p>the image.</p></ol>
 189
 190 <h5>clone_image</h5>
 191 <ol><p>the clone image.</p></ol>
 192
 193  </div>
 194 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 195 _8c.html" target="source" name="DefineImageProperty">DefineImageProperty</a></h2>
 196 <div class="doc-section">
 197
 198 <p>DefineImageProperty() associates a key/value pair with an image property.</p></ol>
 199
 200 <p>The format of the DefineImageProperty method is:</p>
 201
 202 <pre class="code">
 203   MagickBooleanType DefineImageProperty(Image *image,
 204     const char *property)
 205 </pre>
 206
 207 <p>A description of each parameter follows:</p></ol>
 208
 209 <h5>image</h5>
 210 <ol><p>the image.</p></ol>
 211
 212 <h5>property</h5>
 213 <ol><p>the image property.</p></ol>
 214
 215  </div>
 216 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 217 _8c.html" target="source" name="DeleteImageProperty">DeleteImageProperty</a></h2>
 218 <div class="doc-section">
 219
 220 <p>DeleteImageProperty() deletes an image property.</p></ol>
 221
 222 <p>The format of the DeleteImageProperty method is:</p>
 223
 224 <pre class="code">
 225   MagickBooleanType DeleteImageProperty(Image *image,const char *property)
 226 </pre>
 227
 228 <p>A description of each parameter follows:</p></ol>
 229
 230 <h5>image</h5>
 231 <ol><p>the image.</p></ol>
 232
 233 <h5>property</h5>
 234 <ol><p>the image property.</p></ol>
 235
 236  </div>
 237 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 238 _8c.html" target="source" name="DestroyImageProperties">DestroyImageProperties</a></h2>
 239 <div class="doc-section">
 240
 241 <p>DestroyImageProperties() releases memory associated with image property values.</p></ol>
 242
 243 <p>The format of the DestroyDefines method is:</p>
 244
 245 <pre class="code">
 246   void DestroyImageProperties(Image *image)
 247 </pre>
 248
 249 <p>A description of each parameter follows:</p></ol>
 250
 251 <h5>image</h5>
 252 <ol><p>the image.</p></ol>
 253
 254  </div>
 255 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 256 _8c.html" target="source" name="FormatImageProperty">FormatImageProperty</a></h2>
 257 <div class="doc-section">
 258
 259 <p>FormatImageProperty() permits formatted property/value pairs to be saved as an image proporty.</p></ol>
 260
 261 <p>The format of the FormatImageProperty method is:</p>
 262
 263 <pre class="code">
 264   MagickBooleanType FormatImageProperty(Image *image,const char *property,
 265     const char *format,...)
 266 </pre>
 267
 268 <p>A description of each parameter follows.</p></ol>
 269
 270 <h5> image</h5>
 271 <ol><p>The image.</p></ol>
 272
 273 <h5> property</h5>
 274 <ol><p>The attribute property.</p></ol>
 275
 276 <h5> format</h5>
 277 <ol><p>A string describing the format to use to write the remaining arguments.</p></ol>
 278
 279  </div>
 280 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 281 _8c.html" target="source" name="GetImageProperty">GetImageProperty</a></h2>
 282 <div class="doc-section">
 283
 284 <p>GetImageProperty() gets a value associated with an image property.</p></ol>
 285
 286 <p>The format of the GetImageProperty method is:</p>
 287
 288 <pre class="code">
 289   const char *GetImageProperty(const Image *image,const char *key)
 290 </pre>
 291
 292 <p>A description of each parameter follows:</p></ol>
 293
 294 <h5>image</h5>
 295 <ol><p>the image.</p></ol>
 296
 297 <h5>key</h5>
 298 <ol><p>the key.</p></ol>
 299
 300  </div>
 301 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 302 _8c.html" target="source" name="GetNextImageProperty">GetNextImageProperty</a></h2>
 303 <div class="doc-section">
 304
 305 <p>GetNextImageProperty() gets the next image property value.</p></ol>
 306
 307 <p>The format of the GetNextImageProperty method is:</p>
 308
 309 <pre class="code">
 310   char *GetNextImageProperty(const Image *image)
 311 </pre>
 312
 313 <p>A description of each parameter follows:</p></ol>
 314
 315 <h5>image</h5>
 316 <ol><p>the image.</p></ol>
 317
 318  </div>
 319 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 320 _8c.html" target="source" name="InterpretImageProperties">InterpretImageProperties</a></h2>
 321 <div class="doc-section">
 322
 323 <p>InterpretImageProperties() replaces any embedded formatting characters with the appropriate image property and returns the interpretted text.</p></ol>
 324
 325 <p>The format of the InterpretImageProperties method is:</p>
 326
 327 <pre class="code">
 328   char *InterpretImageProperties(const ImageInfo *image_info,Image *image,
 329     const char *embed_text)
 330 </pre>
 331
 332 <p>A description of each parameter follows:</p></ol>
 333
 334 <h5>image_info</h5>
 335 <ol><p>the image info.</p></ol>
 336
 337 <h5>image</h5>
 338 <ol><p>the image.</p></ol>
 339
 340 <h5>embed_text</h5>
 341 <ol><p>the address of a character string containing the embedded formatting characters.</p></ol>
 342
 343  </div>
 344 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 345 _8c.html" target="source" name="RemoveImageProperty">RemoveImageProperty</a></h2>
 346 <div class="doc-section">
 347
 348 <p>RemoveImageProperty() removes a property from the image and returns its value.</p></ol>
 349
 350 <p>The format of the RemoveImageProperty method is:</p>
 351
 352 <pre class="code">
 353   char *RemoveImageProperty(Image *image,const char *property)
 354 </pre>
 355
 356 <p>A description of each parameter follows:</p></ol>
 357
 358 <h5>image</h5>
 359 <ol><p>the image.</p></ol>
 360
 361 <h5>property</h5>
 362 <ol><p>the image property.</p></ol>
 363
 364  </div>
 365 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 366 _8c.html" target="source" name="ResetImagePropertyIterator">ResetImagePropertyIterator</a></h2>
 367 <div class="doc-section">
 368
 369 <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>
 370
 371 <p>The format of the ResetImagePropertyIterator method is:</p>
 372
 373 <pre class="code">
 374   ResetImagePropertyIterator(Image *image)
 375 </pre>
 376
 377 <p>A description of each parameter follows:</p></ol>
 378
 379 <h5>image</h5>
 380 <ol><p>the image.</p></ol>
 381
 382  </div>
 383 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 384 _8c.html" target="source" name="SetImageProperty">SetImageProperty</a></h2>
 385 <div class="doc-section">
 386
 387 <p>SetImageProperty() associates an value with an image property.</p></ol>
 388
 389 <p>The format of the SetImageProperty method is:</p>
 390
 391 <pre class="code">
 392   MagickBooleanType SetImageProperty(Image *image,const char *property,
 393     const char *value)
 394 </pre>
 395
 396 <p>A description of each parameter follows:</p></ol>
 397
 398 <h5>image</h5>
 399 <ol><p>the image.</p></ol>
 400
 401 <h5>property</h5>
 402 <ol><p>the image property.</p></ol>
 403
 404 <h5>values</h5>
 405 <ol><p>the image property values.</p></ol>
 406
 407  </div>
 408 \r
 409 </div>\r
 410 \r
 411 <div id="linkbar">\r
 412     <span id="linkbar-west">&nbsp;</span>\r
 413     <span id="linkbar-center">\r
 414       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 415       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 416     </span>\r
 417     <span id="linkbar-east">&nbsp;</span>\r
 418   </div>\r
 419   <div class="footer">\r
 420     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 421     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 422   </div>\r
 423   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 424   <script type="text/javascript">\r
 425     var _gaq = _gaq || [];\r
 426     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 427     _gaq.push(['_trackPageview']);\r
 428 \r
 429     (function() {\r
 430       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 431       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 432       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 433     })();\r
 434   </script>\r
 435 </body>\r
 436 </html>\r