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.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 127 </div>
 128 <div  class="sponsor">
 129   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
 130 </div>
 131 <div  class="sponsor">
 132   <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
 133 </div>
 134 <div  class="sponsor">
 135   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 136 </div>
 137 <div  class="sponsor">
 138   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201001010120 Buchhorn -->
 139 </div>
 140 </div>
 141 </div>
 142 \r
 143 \r
 144 </div>\r
 145 \r
 146 <div class="main">\r
 147 \r
 148 <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>
 149
 150 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 151 _8c.html" target="source" name="CloneImageProperties">CloneImageProperties</a></h2>
 152 <div class="doc-section">
 153
 154 <p>CloneImageProperties() clones one or more image properties.</p></ol>
 155
 156 <p>The format of the CloneImageProperties method is:</p>
 157
 158 <pre class="code">
 159   MagickBooleanType CloneImageProperties(Image *image,
 160     const Image *clone_image)
 161 </pre>
 162
 163 <p>A description of each parameter follows:</p></ol>
 164
 165 <h5>image</h5>
 166 <ol><p>the image.</p></ol>
 167
 168 <h5>clone_image</h5>
 169 <ol><p>the clone image.</p></ol>
 170
 171  </div>
 172 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 173 _8c.html" target="source" name="DefineImageProperty">DefineImageProperty</a></h2>
 174 <div class="doc-section">
 175
 176 <p>DefineImageProperty() associates a key/value pair with an image property.</p></ol>
 177
 178 <p>The format of the DefineImageProperty method is:</p>
 179
 180 <pre class="code">
 181   MagickBooleanType DefineImageProperty(Image *image,
 182     const char *property)
 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>property</h5>
 191 <ol><p>the image property.</p></ol>
 192
 193  </div>
 194 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 195 _8c.html" target="source" name="DeleteImageProperty">DeleteImageProperty</a></h2>
 196 <div class="doc-section">
 197
 198 <p>DeleteImageProperty() deletes an image property.</p></ol>
 199
 200 <p>The format of the DeleteImageProperty method is:</p>
 201
 202 <pre class="code">
 203   MagickBooleanType DeleteImageProperty(Image *image,const char *property)
 204 </pre>
 205
 206 <p>A description of each parameter follows:</p></ol>
 207
 208 <h5>image</h5>
 209 <ol><p>the image.</p></ol>
 210
 211 <h5>property</h5>
 212 <ol><p>the image property.</p></ol>
 213
 214  </div>
 215 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 216 _8c.html" target="source" name="DestroyImageProperties">DestroyImageProperties</a></h2>
 217 <div class="doc-section">
 218
 219 <p>DestroyImageProperties() releases memory associated with image property values.</p></ol>
 220
 221 <p>The format of the DestroyDefines method is:</p>
 222
 223 <pre class="code">
 224   void DestroyImageProperties(Image *image)
 225 </pre>
 226
 227 <p>A description of each parameter follows:</p></ol>
 228
 229 <h5>image</h5>
 230 <ol><p>the image.</p></ol>
 231
 232  </div>
 233 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 234 _8c.html" target="source" name="FormatImageProperty">FormatImageProperty</a></h2>
 235 <div class="doc-section">
 236
 237 <p>FormatImageProperty() permits formatted property/value pairs to be saved as an image proporty.</p></ol>
 238
 239 <p>The format of the FormatImageProperty method is:</p>
 240
 241 <pre class="code">
 242   MagickBooleanType FormatImageProperty(Image *image,const char *property,
 243     const char *format,...)
 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 <h5> property</h5>
 252 <ol><p>The attribute property.</p></ol>
 253
 254 <h5> format</h5>
 255 <ol><p>A string describing the format to use to write the remaining arguments.</p></ol>
 256
 257  </div>
 258 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 259 _8c.html" target="source" name="GetImageProperty">GetImageProperty</a></h2>
 260 <div class="doc-section">
 261
 262 <p>GetImageProperty() gets a value associated with an image property.</p></ol>
 263
 264 <p>The format of the GetImageProperty method is:</p>
 265
 266 <pre class="code">
 267   const char *GetImageProperty(const Image *image,const char *key)
 268 </pre>
 269
 270 <p>A description of each parameter follows:</p></ol>
 271
 272 <h5>image</h5>
 273 <ol><p>the image.</p></ol>
 274
 275 <h5>key</h5>
 276 <ol><p>the key.</p></ol>
 277
 278  </div>
 279 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 280 _8c.html" target="source" name="GetNextImageProperty">GetNextImageProperty</a></h2>
 281 <div class="doc-section">
 282
 283 <p>GetNextImageProperty() gets the next image property value.</p></ol>
 284
 285 <p>The format of the GetNextImageProperty method is:</p>
 286
 287 <pre class="code">
 288   char *GetNextImageProperty(const Image *image)
 289 </pre>
 290
 291 <p>A description of each parameter follows:</p></ol>
 292
 293 <h5>image</h5>
 294 <ol><p>the image.</p></ol>
 295
 296  </div>
 297 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 298 _8c.html" target="source" name="InterpretImageProperties">InterpretImageProperties</a></h2>
 299 <div class="doc-section">
 300
 301 <p>InterpretImageProperties() replaces any embedded formatting characters with the appropriate image property and returns the interpretted text.</p></ol>
 302
 303 <p>The format of the InterpretImageProperties method is:</p>
 304
 305 <pre class="code">
 306   char *InterpretImageProperties(const ImageInfo *image_info,Image *image,
 307     const char *embed_text)
 308 </pre>
 309
 310 <p>A description of each parameter follows:</p></ol>
 311
 312 <h5>image_info</h5>
 313 <ol><p>the image info.</p></ol>
 314
 315 <h5>image</h5>
 316 <ol><p>the image.</p></ol>
 317
 318 <h5>embed_text</h5>
 319 <ol><p>the address of a character string containing the embedded formatting characters.</p></ol>
 320
 321  </div>
 322 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 323 _8c.html" target="source" name="RemoveImageProperty">RemoveImageProperty</a></h2>
 324 <div class="doc-section">
 325
 326 <p>RemoveImageProperty() removes a property from the image and returns its value.</p></ol>
 327
 328 <p>The format of the RemoveImageProperty method is:</p>
 329
 330 <pre class="code">
 331   char *RemoveImageProperty(Image *image,const char *property)
 332 </pre>
 333
 334 <p>A description of each parameter follows:</p></ol>
 335
 336 <h5>image</h5>
 337 <ol><p>the image.</p></ol>
 338
 339 <h5>property</h5>
 340 <ol><p>the image property.</p></ol>
 341
 342  </div>
 343 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 344 _8c.html" target="source" name="ResetImagePropertyIterator">ResetImagePropertyIterator</a></h2>
 345 <div class="doc-section">
 346
 347 <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>
 348
 349 <p>The format of the ResetImagePropertyIterator method is:</p>
 350
 351 <pre class="code">
 352   ResetImagePropertyIterator(Image *image)
 353 </pre>
 354
 355 <p>A description of each parameter follows:</p></ol>
 356
 357 <h5>image</h5>
 358 <ol><p>the image.</p></ol>
 359
 360  </div>
 361 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 362 _8c.html" target="source" name="SetImageProperty">SetImageProperty</a></h2>
 363 <div class="doc-section">
 364
 365 <p>SetImageProperty() associates an value with an image property.</p></ol>
 366
 367 <p>The format of the SetImageProperty method is:</p>
 368
 369 <pre class="code">
 370   MagickBooleanType SetImageProperty(Image *image,const char *property,
 371     const char *value)
 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 <h5>property</h5>
 380 <ol><p>the image property.</p></ol>
 381
 382 <h5>values</h5>
 383 <ol><p>the image property values.</p></ol>
 384
 385  </div>
 386 \r
 387 </div>\r
 388 \r
 389 <div id="linkbar">\r
 390  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 391     <span id="linkbar-center">\r
 392       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 393       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
 394     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 395     </span>\r
 396     <span id="linkbar-east">&nbsp;</span>\r
 397   </div>\r
 398   <div class="footer">\r
 399     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
 400     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 401   </div>\r
 402   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 403 </body>\r
 404 </html>\r