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 http-equiv="Content-Type" value="application/xhtml+xml" />\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="screen,projection"><!--\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.abi-stoff.de/abizeitung/" title="Abibuch">Abizeitung</a><!-- 20101101000200 -->
 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.goyax.de">Börse</a><!-- 201004010240 Gewiese digital-finance.de -->
 146 </div>
 147 <div  class="sponsor">
 148    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 149 </div>
 150 </div>
 151 </div>
 152 \r
 153 \r
 154 </div>\r
 155 \r
 156 <div class="main">\r
 157 \r
 158 <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>
 159
 160 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 161 _8c.html" target="source" name="CloneImageProperties">CloneImageProperties</a></h2>
 162 <div class="doc-section">
 163
 164 <p>CloneImageProperties() clones one or more image properties.</p></ol>
 165
 166 <p>The format of the CloneImageProperties method is:</p>
 167
 168 <pre class="code">
 169   MagickBooleanType CloneImageProperties(Image *image,
 170     const Image *clone_image)
 171 </pre>
 172
 173 <p>A description of each parameter follows:</p></ol>
 174
 175 <h5>image</h5>
 176 <ol><p>the image.</p></ol>
 177
 178 <h5>clone_image</h5>
 179 <ol><p>the clone image.</p></ol>
 180
 181  </div>
 182 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 183 _8c.html" target="source" name="DefineImageProperty">DefineImageProperty</a></h2>
 184 <div class="doc-section">
 185
 186 <p>DefineImageProperty() associates a key/value pair with an image property.</p></ol>
 187
 188 <p>The format of the DefineImageProperty method is:</p>
 189
 190 <pre class="code">
 191   MagickBooleanType DefineImageProperty(Image *image,
 192     const char *property)
 193 </pre>
 194
 195 <p>A description of each parameter follows:</p></ol>
 196
 197 <h5>image</h5>
 198 <ol><p>the image.</p></ol>
 199
 200 <h5>property</h5>
 201 <ol><p>the image property.</p></ol>
 202
 203  </div>
 204 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 205 _8c.html" target="source" name="DeleteImageProperty">DeleteImageProperty</a></h2>
 206 <div class="doc-section">
 207
 208 <p>DeleteImageProperty() deletes an image property.</p></ol>
 209
 210 <p>The format of the DeleteImageProperty method is:</p>
 211
 212 <pre class="code">
 213   MagickBooleanType DeleteImageProperty(Image *image,const char *property)
 214 </pre>
 215
 216 <p>A description of each parameter follows:</p></ol>
 217
 218 <h5>image</h5>
 219 <ol><p>the image.</p></ol>
 220
 221 <h5>property</h5>
 222 <ol><p>the image property.</p></ol>
 223
 224  </div>
 225 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 226 _8c.html" target="source" name="DestroyImageProperties">DestroyImageProperties</a></h2>
 227 <div class="doc-section">
 228
 229 <p>DestroyImageProperties() releases memory associated with image property values.</p></ol>
 230
 231 <p>The format of the DestroyDefines method is:</p>
 232
 233 <pre class="code">
 234   void DestroyImageProperties(Image *image)
 235 </pre>
 236
 237 <p>A description of each parameter follows:</p></ol>
 238
 239 <h5>image</h5>
 240 <ol><p>the image.</p></ol>
 241
 242  </div>
 243 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 244 _8c.html" target="source" name="FormatImageProperty">FormatImageProperty</a></h2>
 245 <div class="doc-section">
 246
 247 <p>FormatImageProperty() permits formatted property/value pairs to be saved as an image proporty.</p></ol>
 248
 249 <p>The format of the FormatImageProperty method is:</p>
 250
 251 <pre class="code">
 252   MagickBooleanType FormatImageProperty(Image *image,const char *property,
 253     const char *format,...)
 254 </pre>
 255
 256 <p>A description of each parameter follows.</p></ol>
 257
 258 <h5> image</h5>
 259 <ol><p>The image.</p></ol>
 260
 261 <h5> property</h5>
 262 <ol><p>The attribute property.</p></ol>
 263
 264 <h5> format</h5>
 265 <ol><p>A string describing the format to use to write the remaining arguments.</p></ol>
 266
 267  </div>
 268 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 269 _8c.html" target="source" name="GetImageProperty">GetImageProperty</a></h2>
 270 <div class="doc-section">
 271
 272 <p>GetImageProperty() gets a value associated with an image property.</p></ol>
 273
 274 <p>The format of the GetImageProperty method is:</p>
 275
 276 <pre class="code">
 277   const char *GetImageProperty(const Image *image,const char *key)
 278 </pre>
 279
 280 <p>A description of each parameter follows:</p></ol>
 281
 282 <h5>image</h5>
 283 <ol><p>the image.</p></ol>
 284
 285 <h5>key</h5>
 286 <ol><p>the key.</p></ol>
 287
 288  </div>
 289 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 290 _8c.html" target="source" name="GetNextImageProperty">GetNextImageProperty</a></h2>
 291 <div class="doc-section">
 292
 293 <p>GetNextImageProperty() gets the next image property value.</p></ol>
 294
 295 <p>The format of the GetNextImageProperty method is:</p>
 296
 297 <pre class="code">
 298   char *GetNextImageProperty(const Image *image)
 299 </pre>
 300
 301 <p>A description of each parameter follows:</p></ol>
 302
 303 <h5>image</h5>
 304 <ol><p>the image.</p></ol>
 305
 306  </div>
 307 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 308 _8c.html" target="source" name="InterpretImageProperties">InterpretImageProperties</a></h2>
 309 <div class="doc-section">
 310
 311 <p>InterpretImageProperties() replaces any embedded formatting characters with the appropriate image property and returns the interpretted text.</p></ol>
 312
 313 <p>The format of the InterpretImageProperties method is:</p>
 314
 315 <pre class="code">
 316   char *InterpretImageProperties(const ImageInfo *image_info,Image *image,
 317     const char *embed_text)
 318 </pre>
 319
 320 <p>A description of each parameter follows:</p></ol>
 321
 322 <h5>image_info</h5>
 323 <ol><p>the image info.</p></ol>
 324
 325 <h5>image</h5>
 326 <ol><p>the image.</p></ol>
 327
 328 <h5>embed_text</h5>
 329 <ol><p>the address of a character string containing the embedded formatting characters.</p></ol>
 330
 331  </div>
 332 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 333 _8c.html" target="source" name="RemoveImageProperty">RemoveImageProperty</a></h2>
 334 <div class="doc-section">
 335
 336 <p>RemoveImageProperty() removes a property from the image and returns its value.</p></ol>
 337
 338 <p>The format of the RemoveImageProperty method is:</p>
 339
 340 <pre class="code">
 341   char *RemoveImageProperty(Image *image,const char *property)
 342 </pre>
 343
 344 <p>A description of each parameter follows:</p></ol>
 345
 346 <h5>image</h5>
 347 <ol><p>the image.</p></ol>
 348
 349 <h5>property</h5>
 350 <ol><p>the image property.</p></ol>
 351
 352  </div>
 353 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 354 _8c.html" target="source" name="ResetImagePropertyIterator">ResetImagePropertyIterator</a></h2>
 355 <div class="doc-section">
 356
 357 <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>
 358
 359 <p>The format of the ResetImagePropertyIterator method is:</p>
 360
 361 <pre class="code">
 362   ResetImagePropertyIterator(Image *image)
 363 </pre>
 364
 365 <p>A description of each parameter follows:</p></ol>
 366
 367 <h5>image</h5>
 368 <ol><p>the image.</p></ol>
 369
 370  </div>
 371 <h2><a href="http://www.imagemagick.org/api/MagickCore/property
 372 _8c.html" target="source" name="SetImageProperty">SetImageProperty</a></h2>
 373 <div class="doc-section">
 374
 375 <p>SetImageProperty() associates an value with an image property.</p></ol>
 376
 377 <p>The format of the SetImageProperty method is:</p>
 378
 379 <pre class="code">
 380   MagickBooleanType SetImageProperty(Image *image,const char *property,
 381     const char *value)
 382 </pre>
 383
 384 <p>A description of each parameter follows:</p></ol>
 385
 386 <h5>image</h5>
 387 <ol><p>the image.</p></ol>
 388
 389 <h5>property</h5>
 390 <ol><p>the image property.</p></ol>
 391
 392 <h5>values</h5>
 393 <ol><p>the image property values.</p></ol>
 394
 395  </div>
 396 \r
 397 </div>\r
 398 \r
 399 <div id="linkbar">\r
 400  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 401     <span id="linkbar-center">\r
 402       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 403     <a href="http://studio.webbyland.com/ImageMagick/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 404     </span>\r
 405     <span id="linkbar-east">&nbsp;</span>\r
 406   </div>\r
 407   <div class="footer">\r
 408     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 409     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 410   </div>\r
 411   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 412 </body>\r
 413 </html>\r