| Current File : //usr/local/share/doc/ImageMagick-6/www/api/property.html |
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="-//W3C//DTD XHTML 1.1//EN" xml:lang="en" 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>
<meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4"></meta>
<title>ImageMagick: MagickCore, C API for ImageMagick: Get/Set Image Properties</title>
<meta http-equiv="content-language" content="en-US"></meta>
<meta http-equiv="content-type" content="text/html; charset=utf-8"></meta>
<meta http-equiv="reply-to" content="magick-users@imagemagick.org"></meta>
<meta name="application-name" content="ImageMagick"></meta>
<meta name="description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats. In addition, resize, rotate, shear, distort or transform images automagically."></meta>
<meta name="application-url" content="http://www.imagemagick.org"></meta>
<meta name="generator" content="PHP"></meta>
<meta name="keywords" content="magickcore, c, api, for, imagemagick:, get/set, image, properties, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"></meta>
<meta name="rating" content="GENERAL"></meta>
<meta name="robots" content="INDEX, FOLLOW"></meta>
<meta name="generator" content="ImageMagick Studio LLC"></meta>
<meta name="author" content="ImageMagick Studio LLC"></meta>
<meta name="revisit-after" content="2 DAYS"></meta>
<meta name="resource-type" content="document"></meta>
<meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"></meta>
<meta name="distribution" content="Global"></meta>
<link rel="icon" href="../../images/wand.png"></link>
<link rel="shortcut icon" href="../../images/wand.ico" type="images/x-icon"></link>
<link rel="canonical" href="../../index.html"></link>
<link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"></link>
<!-- Add jQuery library -->
<script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
<!-- Add mousewheel plugin (this is optional) -->
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/lib/jquery.mousewheel-3.0.6.pack.js"></script>
<!-- Add fancyBox -->
<link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/jquery.fancybox.css?v=2.0.6" type="text/css" media="screen"></link>
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/jquery.fancybox.pack.js?v=2.0.6"></script>
<!-- Optionally add helpers - button, thumbnail and/or media -->
<link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.css?v=1.0.2" type="text/css" media="screen"></link>
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.js?v=1.0.2"></script>
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-media.js?v=1.0.0"></script>
<link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.css?v=2.0.6" type="text/css" media="screen"></link>
<script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.js?v=2.0.6"></script>
<script type="text/javascript">
$(document).ready(function() {
$(".fancybox").fancybox();
});
</script>
<!-- ImageMagick style -->
<style type="text/css" media="all">
@import url("../../www/magick.css");
</style>
</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>
</div>
<a href="../../discourse-server">
<img src="../../images/logo.jpg" alt="ImageMagick Logo" style="width: 123px; height: 118px; border: 0px; float: right;"></img></a>
<a href="../../index.html">
<img src="../../images/sprite.jpg" alt="ImageMagick Sprite" style="width: 114px; height: 118px; border: 0px; float: right;"></img></a>
</div>
<div class="westbar">
<div class="menu">
<a title="About ImageMagick" href="../../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="http://www.imagemagick.org/script/search.php">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 title="Support ImageMagick Development" href="../../www/support.html">Support ImageMagick Development</a>
</div>
</div>
<div class="eastbar">
<div> <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="../../index.html"></a></div>
<noscript>
<a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank">
<img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" width="93" height="20" border="0"></img></a>
</noscript>
</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#(void) LogMagickEvent(TraceEvent,GetMagickModule">(void) LogMagickEvent(TraceEvent,GetMagickModule</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. &lt; &gt; &amp; replaced by '<', '>', '&' resp. replaced by percent</p>
<p>x [x] where 'x' is a single letter properity, case sensitive). [type:name] where 'type' a is special and 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). It may contain ':' as long as the prefix is not special.</p>
<p>Single letter substitutions will only happen if the character before the percent is NOT a number. But braced substitutions will always be performed. This prevents the typical usage of percent in a interpreted geometry argument from being substituted when the percent is a geometry flag.</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() by the caller.</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="(void)_LogMagickEvent(TraceEvent,GetMagickModule">(void) LogMagickEvent(TraceEvent,GetMagickModule</a></h2>
<div class="doc-section">
<p>(void) LogMagickEvent(TraceEvent,GetMagickModule(),"s",image->filename);</p>
<p>if (embed_text == (const char *) NULL) return((char *) NULL); p=embed_text;</p>
<p>if (*p == '\0') return(ConstantString(""));</p>
<p>/* handle a '@' replace string from file */ if (*p == '@') { p++; if (*p != '-' && (IsPathAccessible(p) == MagickFalse) ) { (void) ThrowMagickException(&image->exception,GetMagickModule(), OptionError,"UnableToAccessPath","s",p); return((char *) NULL); } return(FileToString(p,~0,&image->exception)); }</p>
<p>/* Translate any embedded format 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>In this case the ConstantString() value returned should be freed by the caller when finished.</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="http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> •
<a href="../../discourse-server">Discourse Server</a> •
<a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a> •
<a href="http://jqmagick.imagemagick.org/">JqMagick</a>
</span>
<span id="linkbar-east"> </span>
</div>
<div class="footer">
<span id="footer-west">© 1999-2013 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>
</body>
</html>