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