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 href="../../index.html">About ImageMagick</a>
  49 </div>
  50 <div class="sep"></div>\r
  51 <div class="menu">
  52   <a href="../../www/command-line-tools.html">Command-line Tools</a>
  53 </div>
  54 <div class="sub">
  55     <a href="../../www/command-line-processing.html">Processing</a>
  56 </div>
  57 <div class="sub">
  58     <a href="../../www/command-line-options.html">Options</a>
  59 </div>
  60 <div class="sub">
  61     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  62 </div>
  63 <div class="menu">
  64   <a href="../../www/api.html">Program Interfaces</a>
  65 </div>
  66 <div class="sub">
  67     <a href="../../www/magick-wand.html">MagickWand</a>
  68 </div>
  69 <div class="sub">
  70     <a href="../../www/magick-core.html">MagickCore</a>
  71 </div>
  72 <div class="sub">
  73     <a href="../../www/perl-magick.html">PerlMagick</a>
  74 </div>
  75 <div class="sub">
  76     <a href="../../Magick++/">Magick++</a>
  77 </div>
  78 <div class="menu">
  79   <a href="../../www/architecture.html">Architecture</a>
  80 </div>
  81 <div class="sep"></div>\r
  82 <div  class="menu">
  83    <a href="../../www/install-source.html">Install from Source</a>
  84 </div>
  85 <div class="sub">
  86     <a href="../../www/install-source.html#unix">Unix</a>
  87 </div>
  88 <div class="sub">
  89     <a href="../../www/install-source.html#windows">Windows</a>
  90  </div>
  91 <div class="menu">
  92   <a href="../../www/binary-releases.html">Binary Releases</a>
  93 </div>
  94 <div class="sub">
  95     <a href="../../www/binary-releases.html#unix">Unix</a>
  96 </div>
  97 <div class="sub">
  98     <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
  99 </div>
 100 <div class="sub">
 101     <a href="../../www/binary-releases.html#windows">Windows</a>
 102 </div>
 103 <div class="menu">
 104   <a href="../../www/resources.html">Resources</a>
 105 </div>
 106 <div class="sep"></div>\r
 107 <div class="menu">
 108   <a href="../../www/download.html">Download</a>
 109 </div>
 110 <div class="sep"></div>\r
 111 <div class="menu">
 112   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
 113 </div>
 114 <div class="sep"></div>\r
 115 <div class="menu">
 116   <a href="../../www/sitemap.html">Site Map</a>
 117 </div>
 118 <div  class="sub">
 119     <a href="../../www/links.html">Links</a>
 120 </div>
 121 <div class="sep"></div>\r
 122 <div  class="menu">
 123   <a href="../../www/sponsors.html">Sponsors:</a>
 124
 125 <div class="sponsbox">
 126 <div  class="sponsor">
 127    <a href="http://www.renehornig.com/" title="Webdesign">Webdesign</a><!-- 20110101000120 -->
 128 </div>
 129 <div  class="sponsor">
 130   <a href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
 131 </div>
 132 <div  class="sponsor">
 133   <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
 134 </div>
 135 <div  class="sponsor">
 136   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
 137 </div>
 138 <div  class="sponsor">
 139   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
 140 </div>
 141 <div  class="sponsor">
 142   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 143 </div>
 144 <div  class="sponsor">
 145    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 146 </div>
 147 </div>
 148 </div>
 149 \r
 150 \r
 151 </div>\r
 152 \r
 153 <div class="main">\r
 154 \r
 155 <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>
 156
 157 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 158 _8c.html" target="source" name="CloneImageProperties">CloneImageProperties</a></h2>
 159 <div class="doc-section">
 160
 161 <p>CloneImageProperties() clones one or more image properties.</p></ol>
 162
 163 <p>The format of the CloneImageProperties method is:</p>
 164
 165 <pre class="code">
 166   MagickBooleanType CloneImageProperties(Image *image,
 167     const Image *clone_image)
 168 </pre>
 169
 170 <p>A description of each parameter follows:</p></ol>
 171
 172 <h5>image</h5>
 173 <ol><p>the image.</p></ol>
 174
 175 <h5>clone_image</h5>
 176 <ol><p>the clone image.</p></ol>
 177
 178  </div>
 179 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 180 _8c.html" target="source" name="DefineImageProperty">DefineImageProperty</a></h2>
 181 <div class="doc-section">
 182
 183 <p>DefineImageProperty() associates a key/value pair with an image property.</p></ol>
 184
 185 <p>The format of the DefineImageProperty method is:</p>
 186
 187 <pre class="code">
 188   MagickBooleanType DefineImageProperty(Image *image,
 189     const char *property)
 190 </pre>
 191
 192 <p>A description of each parameter follows:</p></ol>
 193
 194 <h5>image</h5>
 195 <ol><p>the image.</p></ol>
 196
 197 <h5>property</h5>
 198 <ol><p>the image property.</p></ol>
 199
 200  </div>
 201 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 202 _8c.html" target="source" name="DeleteImageProperty">DeleteImageProperty</a></h2>
 203 <div class="doc-section">
 204
 205 <p>DeleteImageProperty() deletes an image property.</p></ol>
 206
 207 <p>The format of the DeleteImageProperty method is:</p>
 208
 209 <pre class="code">
 210   MagickBooleanType DeleteImageProperty(Image *image,const char *property)
 211 </pre>
 212
 213 <p>A description of each parameter follows:</p></ol>
 214
 215 <h5>image</h5>
 216 <ol><p>the image.</p></ol>
 217
 218 <h5>property</h5>
 219 <ol><p>the image property.</p></ol>
 220
 221  </div>
 222 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 223 _8c.html" target="source" name="DestroyImageProperties">DestroyImageProperties</a></h2>
 224 <div class="doc-section">
 225
 226 <p>DestroyImageProperties() releases memory associated with image property values.</p></ol>
 227
 228 <p>The format of the DestroyDefines method is:</p>
 229
 230 <pre class="code">
 231   void DestroyImageProperties(Image *image)
 232 </pre>
 233
 234 <p>A description of each parameter follows:</p></ol>
 235
 236 <h5>image</h5>
 237 <ol><p>the image.</p></ol>
 238
 239  </div>
 240 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 241 _8c.html" target="source" name="FormatImageProperty">FormatImageProperty</a></h2>
 242 <div class="doc-section">
 243
 244 <p>FormatImageProperty() permits formatted property/value pairs to be saved as an image proporty.</p></ol>
 245
 246 <p>The format of the FormatImageProperty method is:</p>
 247
 248 <pre class="code">
 249   MagickBooleanType FormatImageProperty(Image *image,const char *property,
 250     const char *format,...)
 251 </pre>
 252
 253 <p>A description of each parameter follows.</p></ol>
 254
 255 <h5> image</h5>
 256 <ol><p>The image.</p></ol>
 257
 258 <h5> property</h5>
 259 <ol><p>The attribute property.</p></ol>
 260
 261 <h5> format</h5>
 262 <ol><p>A string describing the format to use to write the remaining arguments.</p></ol>
 263
 264  </div>
 265 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 266 _8c.html" target="source" name="GetImageProperty">GetImageProperty</a></h2>
 267 <div class="doc-section">
 268
 269 <p>GetImageProperty() gets a value associated with an image property.</p></ol>
 270
 271 <p>The format of the GetImageProperty method is:</p>
 272
 273 <pre class="code">
 274   const char *GetImageProperty(const Image *image,const char *key)
 275 </pre>
 276
 277 <p>A description of each parameter follows:</p></ol>
 278
 279 <h5>image</h5>
 280 <ol><p>the image.</p></ol>
 281
 282 <h5>key</h5>
 283 <ol><p>the key.</p></ol>
 284
 285  </div>
 286 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 287 _8c.html" target="source" name="GetNextImageProperty">GetNextImageProperty</a></h2>
 288 <div class="doc-section">
 289
 290 <p>GetNextImageProperty() gets the next image property value.</p></ol>
 291
 292 <p>The format of the GetNextImageProperty method is:</p>
 293
 294 <pre class="code">
 295   char *GetNextImageProperty(const Image *image)
 296 </pre>
 297
 298 <p>A description of each parameter follows:</p></ol>
 299
 300 <h5>image</h5>
 301 <ol><p>the image.</p></ol>
 302
 303  </div>
 304 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 305 _8c.html" target="source" name="InterpretImageProperties">InterpretImageProperties</a></h2>
 306 <div class="doc-section">
 307
 308 <p>InterpretImageProperties() replaces any embedded formatting characters with the appropriate image property and returns the interpretted text.</p></ol>
 309
 310 <p>The format of the InterpretImageProperties method is:</p>
 311
 312 <pre class="code">
 313   char *InterpretImageProperties(const ImageInfo *image_info,Image *image,
 314     const char *embed_text)
 315 </pre>
 316
 317 <p>A description of each parameter follows:</p></ol>
 318
 319 <h5>image_info</h5>
 320 <ol><p>the image info.</p></ol>
 321
 322 <h5>image</h5>
 323 <ol><p>the image.</p></ol>
 324
 325 <h5>embed_text</h5>
 326 <ol><p>the address of a character string containing the embedded formatting characters.</p></ol>
 327
 328  </div>
 329 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 330 _8c.html" target="source" name="RemoveImageProperty">RemoveImageProperty</a></h2>
 331 <div class="doc-section">
 332
 333 <p>RemoveImageProperty() removes a property from the image and returns its value.</p></ol>
 334
 335 <p>The format of the RemoveImageProperty method is:</p>
 336
 337 <pre class="code">
 338   char *RemoveImageProperty(Image *image,const char *property)
 339 </pre>
 340
 341 <p>A description of each parameter follows:</p></ol>
 342
 343 <h5>image</h5>
 344 <ol><p>the image.</p></ol>
 345
 346 <h5>property</h5>
 347 <ol><p>the image property.</p></ol>
 348
 349  </div>
 350 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 351 _8c.html" target="source" name="ResetImagePropertyIterator">ResetImagePropertyIterator</a></h2>
 352 <div class="doc-section">
 353
 354 <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>
 355
 356 <p>The format of the ResetImagePropertyIterator method is:</p>
 357
 358 <pre class="code">
 359   ResetImagePropertyIterator(Image *image)
 360 </pre>
 361
 362 <p>A description of each parameter follows:</p></ol>
 363
 364 <h5>image</h5>
 365 <ol><p>the image.</p></ol>
 366
 367  </div>
 368 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 369 _8c.html" target="source" name="SetImageProperty">SetImageProperty</a></h2>
 370 <div class="doc-section">
 371
 372 <p>SetImageProperty() associates an value with an image property.</p></ol>
 373
 374 <p>The format of the SetImageProperty method is:</p>
 375
 376 <pre class="code">
 377   MagickBooleanType SetImageProperty(Image *image,const char *property,
 378     const char *value)
 379 </pre>
 380
 381 <p>A description of each parameter follows:</p></ol>
 382
 383 <h5>image</h5>
 384 <ol><p>the image.</p></ol>
 385
 386 <h5>property</h5>
 387 <ol><p>the image property.</p></ol>
 388
 389 <h5>values</h5>
 390 <ol><p>the image property values.</p></ol>
 391
 392  </div>
 393 \r
 394 </div>\r
 395 \r
 396 <div id="linkbar">\r
 397  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 398     <span id="linkbar-center">\r
 399       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</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-2010 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