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="eastbar">\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="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  53 </div>
  54 <div class="sub">
  55     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  56 </div>
  57 <div class="sub">
  58     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  59 </div>
  60 <div class="sub">
  61     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  62 </div>
  63 <div class="menu">
  64   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
  65 </div>
  66 <div class="sub">
  67     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
  68 </div>
  69 <div class="sub">
  70     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
  71 </div>
  72 <div class="sub">
  73     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
  74 </div>
  75 <div class="sub">
  76     <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
  77 </div>
  78 <div class="menu">
  79   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
  80 </div>
  81 <div class="sep"></div>\r
  82 <div  class="menu">
  83    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
  84 </div>
  85 <div class="sub">
  86     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
  87 </div>
  88 <div class="sub">
  89     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
  90  </div>
  91 <div class="menu">
  92   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  93 </div>
  94 <div class="sub">
  95     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  96 </div>
  97 <div class="sub">
  98     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  99 </div>
 100 <div class="sub">
 101     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
 102 </div>
 103 <div class="menu">
 104   <a title="Resources" href="../../www/resources.html">Resources</a>
 105 </div>
 106 <div class="sep"></div>\r
 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: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 128 </div>
 129 <div  class="sponsor">
 130   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 131 </div>
 132 <div  class="sponsor">
 133   <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
 134 </div>
 135 <div  class="sponsor">
 136   <a title="Sponsor: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
 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>
 145 </div>
 146 \r
 147 \r
 148 </div>\r
 149 \r
 150 <div class="main">\r
 151 \r
 152 <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>
 153
 154 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 155 _8c.html" target="source" name="CloneImageProperties">CloneImageProperties</a></h2>
 156 <div class="doc-section">
 157
 158 <p>CloneImageProperties() clones one or more image properties.</p></ol>
 159
 160 <p>The format of the CloneImageProperties method is:</p>
 161
 162 <pre class="code">
 163   MagickBooleanType CloneImageProperties(Image *image,
 164     const Image *clone_image)
 165 </pre>
 166
 167 <p>A description of each parameter follows:</p></ol>
 168
 169 <h5>image</h5>
 170 <ol><p>the image.</p></ol>
 171
 172 <h5>clone_image</h5>
 173 <ol><p>the clone image.</p></ol>
 174
 175  </div>
 176 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 177 _8c.html" target="source" name="DefineImageProperty">DefineImageProperty</a></h2>
 178 <div class="doc-section">
 179
 180 <p>DefineImageProperty() associates a key/value pair with an image property.</p></ol>
 181
 182 <p>The format of the DefineImageProperty method is:</p>
 183
 184 <pre class="code">
 185   MagickBooleanType DefineImageProperty(Image *image,
 186     const char *property)
 187 </pre>
 188
 189 <p>A description of each parameter follows:</p></ol>
 190
 191 <h5>image</h5>
 192 <ol><p>the image.</p></ol>
 193
 194 <h5>property</h5>
 195 <ol><p>the image property.</p></ol>
 196
 197  </div>
 198 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 199 _8c.html" target="source" name="DeleteImageProperty">DeleteImageProperty</a></h2>
 200 <div class="doc-section">
 201
 202 <p>DeleteImageProperty() deletes an image property.</p></ol>
 203
 204 <p>The format of the DeleteImageProperty method is:</p>
 205
 206 <pre class="code">
 207   MagickBooleanType DeleteImageProperty(Image *image,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="DestroyImageProperties">DestroyImageProperties</a></h2>
 221 <div class="doc-section">
 222
 223 <p>DestroyImageProperties() releases memory associated with image property values.</p></ol>
 224
 225 <p>The format of the DestroyDefines method is:</p>
 226
 227 <pre class="code">
 228   void DestroyImageProperties(Image *image)
 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  </div>
 237 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 238 _8c.html" target="source" name="FormatImageProperty">FormatImageProperty</a></h2>
 239 <div class="doc-section">
 240
 241 <p>FormatImageProperty() permits formatted property/value pairs to be saved as an image proporty.</p></ol>
 242
 243 <p>The format of the FormatImageProperty method is:</p>
 244
 245 <pre class="code">
 246   MagickBooleanType FormatImageProperty(Image *image,const char *property,
 247     const char *format,...)
 248 </pre>
 249
 250 <p>A description of each parameter follows.</p></ol>
 251
 252 <h5> image</h5>
 253 <ol><p>The image.</p></ol>
 254
 255 <h5> property</h5>
 256 <ol><p>The attribute property.</p></ol>
 257
 258 <h5> format</h5>
 259 <ol><p>A string describing the format to use to write the remaining arguments.</p></ol>
 260
 261  </div>
 262 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 263 _8c.html" target="source" name="GetImageProperty">GetImageProperty</a></h2>
 264 <div class="doc-section">
 265
 266 <p>GetImageProperty() gets a value associated with an image property.</p></ol>
 267
 268 <p>The format of the GetImageProperty method is:</p>
 269
 270 <pre class="code">
 271   const char *GetImageProperty(const Image *image,const char *key)
 272 </pre>
 273
 274 <p>A description of each parameter follows:</p></ol>
 275
 276 <h5>image</h5>
 277 <ol><p>the image.</p></ol>
 278
 279 <h5>key</h5>
 280 <ol><p>the key.</p></ol>
 281
 282  </div>
 283 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 284 _8c.html" target="source" name="GetNextImageProperty">GetNextImageProperty</a></h2>
 285 <div class="doc-section">
 286
 287 <p>GetNextImageProperty() gets the next image property value.</p></ol>
 288
 289 <p>The format of the GetNextImageProperty method is:</p>
 290
 291 <pre class="code">
 292   char *GetNextImageProperty(const Image *image)
 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  </div>
 301 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 302 _8c.html" target="source" name="InterpretImageProperties">InterpretImageProperties</a></h2>
 303 <div class="doc-section">
 304
 305 <p>InterpretImageProperties() replaces any embedded formatting characters with the appropriate image property and returns the interpretted text.</p></ol>
 306
 307 <p>The format of the InterpretImageProperties method is:</p>
 308
 309 <pre class="code">
 310   char *InterpretImageProperties(const ImageInfo *image_info,Image *image,
 311     const char *embed_text)
 312 </pre>
 313
 314 <p>A description of each parameter follows:</p></ol>
 315
 316 <h5>image_info</h5>
 317 <ol><p>the image info.</p></ol>
 318
 319 <h5>image</h5>
 320 <ol><p>the image.</p></ol>
 321
 322 <h5>embed_text</h5>
 323 <ol><p>the address of a character string containing the embedded formatting characters.</p></ol>
 324
 325  </div>
 326 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 327 _8c.html" target="source" name="RemoveImageProperty">RemoveImageProperty</a></h2>
 328 <div class="doc-section">
 329
 330 <p>RemoveImageProperty() removes a property from the image and returns its value.</p></ol>
 331
 332 <p>The format of the RemoveImageProperty method is:</p>
 333
 334 <pre class="code">
 335   char *RemoveImageProperty(Image *image,const char *property)
 336 </pre>
 337
 338 <p>A description of each parameter follows:</p></ol>
 339
 340 <h5>image</h5>
 341 <ol><p>the image.</p></ol>
 342
 343 <h5>property</h5>
 344 <ol><p>the image property.</p></ol>
 345
 346  </div>
 347 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 348 _8c.html" target="source" name="ResetImagePropertyIterator">ResetImagePropertyIterator</a></h2>
 349 <div class="doc-section">
 350
 351 <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>
 352
 353 <p>The format of the ResetImagePropertyIterator method is:</p>
 354
 355 <pre class="code">
 356   ResetImagePropertyIterator(Image *image)
 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  </div>
 365 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 366 _8c.html" target="source" name="SetImageProperty">SetImageProperty</a></h2>
 367 <div class="doc-section">
 368
 369 <p>SetImageProperty() associates an value with an image property.</p></ol>
 370
 371 <p>The format of the SetImageProperty method is:</p>
 372
 373 <pre class="code">
 374   MagickBooleanType SetImageProperty(Image *image,const char *property,
 375     const char *value)
 376 </pre>
 377
 378 <p>A description of each parameter follows:</p></ol>
 379
 380 <h5>image</h5>
 381 <ol><p>the image.</p></ol>
 382
 383 <h5>property</h5>
 384 <ol><p>the image property.</p></ol>
 385
 386 <h5>values</h5>
 387 <ol><p>the image property values.</p></ol>
 388
 389  </div>
 390 \r
 391 </div>\r
 392 \r
 393 <div id="linkbar">\r
 394  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 395     <span id="linkbar-center">\r
 396       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 397     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 398     </span>\r
 399     <span id="linkbar-east">&nbsp;</span>\r
 400   </div>\r
 401   <div class="footer">\r
 402     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 403     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 404   </div>\r
 405   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 406 </body>\r
 407 </html>\r