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