| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" |
| "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd"> |
| <html version="-//W3C//DTD XHTML 1.1//EN" |
| xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" |
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" |
| xsi:schemaLocation="http://www.w3.org/1999/xhtml |
| http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd"> |
| <head> |
| <meta http-equiv="content-type" content="text/html; charset=UTF-8"/> |
| <meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/> |
| <title>ImageMagick: MagickCore, C API for ImageMagick: Get/Set Image Properties</title> |
| <meta http-equiv="content-language" content="en-US"/> |
| <meta http-equiv="content-type" content="text/html; charset=utf-8"/> |
| <meta http-equiv="reply-to" content="[email protected]"/> |
| <meta name="application-name" content="ImageMagick"/> |
| <meta name="description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition resize, rotate, shear, distort and transform images automagically."/> |
| <meta name="application-url" content="http://www.imagemagick.org"/> |
| <meta name="generator" content="PHP"/> |
| <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, Image, Processing, Automagically"/> |
| <meta name="rating" content="GENERAL"/> |
| <meta name="robots" content="INDEX, FOLLOW"/> |
| <meta name="generator" content="ImageMagick Studio LLC"/> |
| <meta name="author" content="ImageMagick Studio LLC"/> |
| <meta name="revisit-after" content="2 DAYS"/> |
| <meta name="resource-type" content="document"/> |
| <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"/> |
| <meta name="distribution" content="Global"/> |
| <link rel="icon" href="../../images/wand.png"/> |
| <link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"/> |
| <link rel="canonical" href="http://www.imagemagick.org" /> |
| <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/> |
| <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" /> |
| <link rel="stylesheet" type="text/css" href="http://www.imagemagick.org/fancybox/jquery.fancybox-1.3.4.css" media="screen" /> |
| <style type="text/css" media="all"> |
| @import url("../../style/magick.html"); |
| </style> |
| <script type="text/javascript" src="https://apis.google.com/js/plusone.js"></script> |
| <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script> |
| <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox-1.3.4.pack.js"></script> |
| <script type="text/javascript"> |
| $(document).ready(function() { |
| $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({ |
| 'transitionIn' : 'elastic', |
| 'transitionOut' : 'elastic', |
| 'overlayShow' : false, |
| 'opacity' : true |
| }); |
| }); |
| </script> |
| </head> |
| |
| <body id="www-imagemagick-org"> |
| <div class="titlebar"> |
| <div style="margin: 17px auto; float: left;"> |
| <script type="text/javascript"> |
| <!-- |
| google_ad_client = "pub-3129977114552745"; |
| google_ad_slot = "5439289906"; |
| google_ad_width = 728; |
| google_ad_height = 90; |
| //--> |
| </script> |
| <script type="text/javascript" |
| src="http://pagead2.googlesyndication.com/pagead/show_ads.js"> |
| </script> |
| </div> |
| <a href="../../discourse-server"> |
| <img src="../../images/logo.jpg" |
| alt="ImageMagick Logo" |
| style="width: 123px; height: 118px; border: 0px; float: right;" /></a> |
| <a href="http://www.imagemagick.org/ImageMagick-7.0.0/index.html"> |
| <img src="../../images/sprite.jpg" |
| alt="ImageMagick Sprite" |
| style="width: 114px; height: 118px; border: 0px; float: right;" /></a> |
| </div> |
| |
| <div class="westbar"> |
| |
| <div class="menu"> |
| <a title="About ImageMagick" href="http://www.imagemagick.org/ImageMagick-7.0.0/index.html">About ImageMagick</a> |
| </div> |
| <div class="menu"> |
| <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a> |
| </div> |
| <div class="sub"> |
| <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a> |
| </div> |
| <div class="sub"> |
| <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a> |
| </div> |
| <div class="sub"> |
| <a title="Binary Release: iOS" href="../../www/binary-releases.html#iOS">iOS</a> |
| </div> |
| <div class="sub"> |
| <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a> |
| </div> |
| <div class="sep"></div> |
| <div class="menu"> |
| <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a> |
| </div> |
| <div class="sub"> |
| <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a> |
| </div> |
| <div class="sub"> |
| <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a> |
| </div> |
| <div class="sub"> |
| <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a> |
| </div> |
| <div class="menu"> |
| <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a> |
| </div> |
| <div class="sub"> |
| <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a> |
| </div> |
| <div class="sub"> |
| <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a> |
| </div> |
| <div class="sub"> |
| <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a> |
| </div> |
| <div class="sub"> |
| <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a> |
| </div> |
| <div class="sep"></div> |
| <div class="menu"> |
| <a title="Install from Source" href="../../www/install-source.html">Install from Source</a> |
| </div> |
| <div class="sub"> |
| <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a> |
| </div> |
| <div class="sub"> |
| <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a> |
| </div> |
| <div class="menu"> |
| <a title="Resources" href="../../www/resources.html">Resources</a> |
| </div> |
| <div class="menu"> |
| <a title="Architecture" href="../../www/architecture.html">Architecture</a> |
| </div> |
| <div class="menu"> |
| <a title="Download" href="../../www/download.html">Download</a> |
| </div> |
| <div class="sep"></div> |
| <div class="menu"> |
| <a title="Search" href="../../www/search.html">Search</a> |
| </div> |
| <div class="sep"></div> |
| <div class="menu"> |
| <a title="Site Map" href="../../www/sitemap.html">Site Map</a> |
| </div> |
| <div class="sub"> |
| <a title="Site Map: Links" href="../../www/links.html">Links</a> |
| </div> |
| <div class="sep"></div> |
| <div class="menu"> |
| <a rel="follow" title="Sponsors" href="../../www/sponsors.html">Sponsors:</a> |
| |
| <a href="http://www.networkredux.com"> |
| <img src="../../images/networkredux.png" width="140" height="31" alt="[sponsor]" |
| style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a> |
| <div class="sponsbox"> |
| <div class="sponsor"> |
| <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 2012070100250 ... --> |
| </div> |
| <div class="sponsor"> |
| <a rel="follow" title="Sponsor: Stock Photography" href="http://www.fotosearch.com/">Stock Photography</a><!-- 2012040100250 ... --> |
| </div> |
| <div class="sponsor"> |
| <a rel="follow" title="Sponsor: Best Local Services" href="http://www.openchime.com">Best Local Services</a><!-- 2012010100150 joey@openc... --> |
| </div> |
| <div class="sponsor"> |
| <a rel="follow" title="Sponsor: Managed Server" href="http://www.robhost.de">Managed Server</a><!-- 201210010720 klikics... --> |
| </div> |
| <div class="sponsor"> |
| <a rel="follow" title="Sponsor: VPS" href="http://www.interdominios.com/vps">VPS</a><!-- 201201010090 barsh@inter... --> |
| </div> |
| <div class="sponsor"> |
| <a rel="follow" title="Sponsor: Autoteile" href="http://www.q11-shop.de">Autoteile</a><!-- 201205010540 suvalj --> |
| </div> |
| <div class="sponsor"> |
| <a rel="follow" title="Sponsor: Web Hosting" href="http://www.micfo.com">Web Hosting</a><!-- 209901010090s golestan --> |
| </div> |
| <div class="sponsor"> |
| <a rel="follow" title="Sponsor: Web Hosting Deals" href="http://www.webhostingdeals.org">Web Hosting Deals</a><!-- 201111010270 chee.hoa darin --> |
| </div> |
| <div class="sponsor"> |
| <a rel="follow" title="Sponsor: Autos part" href="http://www.pkwteile.de/autoteile">Autos part</a><!-- 201112010090s jr@pkwte... --> |
| </div> |
| <div class="sponsor"> |
| <a rel="follow" title="Sponsor: Web Hosting Reviews" href="http://www.webhostingsecretrevealed.com">Web Hosting Secret Revealed</a><!-- 201204010540 iamchee jerry --> |
| </div> |
| <div class="sponsor"> |
| <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo --> |
| </div> |
| <div class="sponsor"> |
| <a rel="follow" title="Sponsor: Hotel München" href="http://www.messehotel-erb-muenchen.de">Hotel München</a><!-- 201111010450 cerb --> |
| </div> |
| <div class="sponsor"> |
| <a rel="follow" title="Sponsor: Günstige Turbolader" href="http://www.autoteile-carparts.de/">Günstige Turbolader</a><!-- 20111101000030 --> |
| </div> |
| <div class="sponsor"> |
| <a rel="follow" title="Sponsor: Got Stripes?" href="http://www.stripeslawncare.org">Got Stripes?</a><!-- 2012010100150 [email protected]> |
| </div> |
| </div> |
| </div> |
| </div> |
| |
| <div class="eastbar"> |
| <div class="g-plusone" id="gplusone"></div> |
| <script type="text/javascript"> |
| window.___gcfg = { |
| lang: 'en-US' |
| }; |
| |
| (function() { |
| var po = document.createElement('offline-script'); |
| po.type = 'text/javascript'; po.async = true; |
| po.src = 'https://apis.google.com/js/plusone.js'; |
| var script = document.getElementsByTagName('offline-script')[0]; |
| script.parentNode.insertBefore(po, script); |
| })(); |
| var gplusone = document.getElementById("gplusone"); |
| gplusone.setAttribute("data-size","medium"); |
| gplusone.setAttribute("data-count","false"); |
| </script> |
| </div> |
| |
| <div class="main"> |
| |
| <h1>Module property Methods</h1> |
| <p class="navigation-index">[<a href="property.html#CloneImageProperties">CloneImageProperties</a> • <a href="property.html#DefineImageProperty">DefineImageProperty</a> • <a href="property.html#DeleteImageProperty">DeleteImageProperty</a> • <a href="property.html#DestroyImageProperties">DestroyImageProperties</a> • <a href="property.html#FormatImageProperty">FormatImageProperty</a> • <a href="property.html#GetImageProperty">GetImageProperty</a> • <a href="property.html#GetNextImageProperty">GetNextImageProperty</a> • <a href="property.html#InterpretImageProperties">InterpretImageProperties</a> • <a href="property.html#RemoveImageProperty">RemoveImageProperty</a> • <a href="property.html#ResetImagePropertyIterator">ResetImagePropertyIterator</a> • <a href="property.html#SetImageProperty">SetImageProperty</a>]</p> |
| |
| <h2><a href="http://www.imagemagick.org/api/MagickCore/property_8c.html" id="CloneImageProperties">CloneImageProperties</a></h2> |
| <div class="doc-section"> |
| |
| <p>CloneImageProperties() clones one or more image properties.</p> |
| |
| <p>The format of the CloneImageProperties method is:</p> |
| |
| <pre class="code"> |
| MagickBooleanType CloneImageProperties(Image *image, |
| const Image *clone_image) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <h5>image</h5> |
| <p>the image.</p> |
| |
| <h5>clone_image</h5> |
| <p>the clone image.</p> |
| |
| </div> |
| <h2><a href="http://www.imagemagick.org/api/MagickCore/property_8c.html" id="DefineImageProperty">DefineImageProperty</a></h2> |
| <div class="doc-section"> |
| |
| <p>DefineImageProperty() associates a key/value pair with an image property.</p> |
| |
| <p>The format of the DefineImageProperty method is:</p> |
| |
| <pre class="code"> |
| MagickBooleanType DefineImageProperty(Image *image, |
| const char *property) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <h5>image</h5> |
| <p>the image.</p> |
| |
| <h5>property</h5> |
| <p>the image property.</p> |
| |
| </div> |
| <h2><a href="http://www.imagemagick.org/api/MagickCore/property_8c.html" id="DeleteImageProperty">DeleteImageProperty</a></h2> |
| <div class="doc-section"> |
| |
| <p>DeleteImageProperty() deletes an image property.</p> |
| |
| <p>The format of the DeleteImageProperty method is:</p> |
| |
| <pre class="code"> |
| MagickBooleanType DeleteImageProperty(Image *image,const char *property) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <h5>image</h5> |
| <p>the image.</p> |
| |
| <h5>property</h5> |
| <p>the image property.</p> |
| |
| </div> |
| <h2><a href="http://www.imagemagick.org/api/MagickCore/property_8c.html" id="DestroyImageProperties">DestroyImageProperties</a></h2> |
| <div class="doc-section"> |
| |
| <p>DestroyImageProperties() releases memory associated with image property values.</p> |
| |
| <p>The format of the DestroyDefines method is:</p> |
| |
| <pre class="code"> |
| void DestroyImageProperties(Image *image) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <h5>image</h5> |
| <p>the image.</p> |
| |
| </div> |
| <h2><a href="http://www.imagemagick.org/api/MagickCore/property_8c.html" id="FormatImageProperty">FormatImageProperty</a></h2> |
| <div class="doc-section"> |
| |
| <p>FormatImageProperty() permits formatted property/value pairs to be saved as an image property.</p> |
| |
| <p>The format of the FormatImageProperty method is:</p> |
| |
| <pre class="code"> |
| MagickBooleanType FormatImageProperty(Image *image,const char *property, |
| const char *format,...) |
| </pre> |
| |
| <p>A description of each parameter follows.</p> |
| |
| <h5> image</h5> |
| <p>The image.</p> |
| |
| <h5> property</h5> |
| <p>The attribute property.</p> |
| |
| <h5> format</h5> |
| <p>A string describing the format to use to write the remaining arguments.</p> |
| |
| </div> |
| <h2><a href="http://www.imagemagick.org/api/MagickCore/property_8c.html" id="GetImageProperty">GetImageProperty</a></h2> |
| <div class="doc-section"> |
| |
| <p>GetImageProperty() gets a value associated with an image property.</p> |
| |
| <p>The format of the GetImageProperty method is:</p> |
| |
| <pre class="code"> |
| const char *GetImageProperty(const Image *image,const char *key) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <h5>image</h5> |
| <p>the image.</p> |
| |
| <h5>key</h5> |
| <p>the key.</p> |
| |
| </div> |
| <h2><a href="http://www.imagemagick.org/api/MagickCore/property_8c.html" id="GetNextImageProperty">GetNextImageProperty</a></h2> |
| <div class="doc-section"> |
| |
| <p>GetNextImageProperty() gets the next free-form string property name.</p> |
| |
| <p>The format of the GetNextImageProperty method is:</p> |
| |
| <pre class="code"> |
| char *GetNextImageProperty(const Image *image) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <h5>image</h5> |
| <p>the image.</p> |
| |
| </div> |
| <h2><a href="http://www.imagemagick.org/api/MagickCore/property_8c.html" id="InterpretImageProperties">InterpretImageProperties</a></h2> |
| <div class="doc-section"> |
| |
| <p>InterpretImageProperties() replaces any embedded formatting characters with the appropriate image property and returns the interpreted text.</p> |
| |
| <p>This searches for and replaces \n \r \ replaced by newline, return, and percent resp. < > & replaced by '<', '>', '&' resp. replaced by percent</p> |
| |
| <p>x where 'x' is a single letter, case sensitive). [type:name] where 'type' is specifically known prefix. [name] where 'name' is a specifically known attribute, calculated value, or a per-image property string name, or a per-image 'artifact' (as generated from a global option)</p> |
| |
| <p>If 'glob-expresions' ('*' or '?' characters) is used for 'name' it may be used as a search pattern to print multiple lines of "name=value\n" pairs of the associacted set of properities.</p> |
| |
| <p>The returned string must be freed using DestoryString().</p> |
| |
| <p>The format of the InterpretImageProperties method is:</p> |
| |
| <pre class="code"> |
| char *InterpretImageProperties(const ImageInfo *image_info,Image *image, |
| const char *embed_text) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <h5>image_info</h5> |
| <p>the image info.</p> |
| |
| <h5>image</h5> |
| <p>the image.</p> |
| |
| <h5>embed_text</h5> |
| <p>the address of a character string containing the embedded formatting characters.</p> |
| |
| </div> |
| <h2><a href="http://www.imagemagick.org/api/MagickCore/property_8c.html" id="RemoveImageProperty">RemoveImageProperty</a></h2> |
| <div class="doc-section"> |
| |
| <p>RemoveImageProperty() removes a property from the image and returns its value.</p> |
| |
| <p>The format of the RemoveImageProperty method is:</p> |
| |
| <pre class="code"> |
| char *RemoveImageProperty(Image *image,const char *property) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <h5>image</h5> |
| <p>the image.</p> |
| |
| <h5>property</h5> |
| <p>the image property.</p> |
| |
| </div> |
| <h2><a href="http://www.imagemagick.org/api/MagickCore/property_8c.html" id="ResetImagePropertyIterator">ResetImagePropertyIterator</a></h2> |
| <div class="doc-section"> |
| |
| <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> |
| |
| <p>The format of the ResetImagePropertyIterator method is:</p> |
| |
| <pre class="code"> |
| ResetImagePropertyIterator(Image *image) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <h5>image</h5> |
| <p>the image.</p> |
| |
| </div> |
| <h2><a href="http://www.imagemagick.org/api/MagickCore/property_8c.html" id="SetImageProperty">SetImageProperty</a></h2> |
| <div class="doc-section"> |
| |
| <p>SetImageProperty() saves the given string value either to specific known attribute or to a freeform property string.</p> |
| |
| <p>The format of the SetImageProperty method is:</p> |
| |
| <pre class="code"> |
| MagickBooleanType SetImageProperty(Image *image,const char *property, |
| const char *value) |
| </pre> |
| |
| <p>A description of each parameter follows:</p> |
| |
| <h5>image</h5> |
| <p>the image.</p> |
| |
| <h5>property</h5> |
| <p>the image property.</p> |
| |
| <h5>values</h5> |
| <p>the image property values.</p> |
| |
| </div> |
| |
| </div> |
| |
| <div id="linkbar"> |
| <span id="linkbar-west"> </span> |
| <span id="linkbar-center"> |
| <a href="../../discourse-server">Discourse Server</a> • |
| <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a> |
| </span> |
| <span id="linkbar-east"> </span> |
| </div> |
| <div class="footer"> |
| <span id="footer-west">© 1999-2011 ImageMagick Studio LLC</span> |
| <span id="footer-east"> <a href="../../www/contact.html">Contact the Wizards</a></span> |
| </div> |
| <div style="clear: both; margin: 0; width: 100%; "></div> |
| <script type="text/javascript"> |
| var _gaq = _gaq || []; |
| _gaq.push(['_setAccount', 'UA-17690367-1']); |
| _gaq.push(['_trackPageview']); |
| |
| (function() { |
| var ga = document.createElement('offline-script'); ga.type = 'text/javascript'; ga.async = true; |
| ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; |
| var s = document.getElementsByTagName('offline-script')[0]; s.parentNode.insertBefore(ga, s); |
| })(); |
| </script> |
| </body> |
| </html> |
