| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445 |
- <!doctype html>
- <html lang="en">
- <head>
- <meta charset="utf-8" />
- <meta name="viewport" content="width=device-width, initial-scale=1" />
- <title>ImageMagick – MagickCore, C API: Get/Set Image Properties</title>
- <meta name="application-name" content="ImageMagick" />
- <meta name="description" content="" />
- <meta name="application-url" content="https://imagemagick.org" />
- <meta name="generator" content="PHP" />
- <meta name="keywords" content="magickcore, c, api:, get/set, image, properties, image processing software" />
- <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 ImageMagick Studio LLC" />
- <meta name="distribution" content="Global" />
- <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1" />
- <meta property='og:url' content='../../' />
- <meta property='og:title' content='ImageMagick' />
- <meta property='og:image' content='../../../images/logo.png' />
- <meta property='og:type' content='website' />
- <meta property='og:site_name' content='ImageMagick' />
- <meta property='og:description' content="Create, Edit, Compose, or Convert Digital Images" />
- <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
- <link href="property.html" rel="canonical" />
- <link href="../../../images/wand.png" rel="icon" />
- <link href="../../../images/wand.ico" rel="shortcut icon" />
- <link href="../../assets/magick.css" rel="stylesheet" />
- </head>
- <body>
- <nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top">
- <div class="container-fluid">
- <a class="navbar-brand" href="../../"><img class="d-block" id="icon" alt="ImageMagick" width="32" height="32" src="../../../images/wand.ico"/></a>
- <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#magick-navbars" aria-controls="magick-navbars" aria-expanded="false" aria-label="Toggle navigation">
- <span class="navbar-toggler-icon"></span>
- </button>
- <div class="collapse navbar-collapse" id="magick-navbars">
- <ul class="navbar-nav me-auto mb-2 mb-md-0">
- <li class="nav-item">
- <a class="nav-link " href="../../www/download.html">Download</a>
- </li>
- <li class="nav-item">
- <a class="nav-link " href="../../www/command-line-tools.html">Tools</a>
- </li>
- <li class="nav-item">
- <a class="nav-link " href="../../www/command-line-processing.html">CLI</a>
- </li>
- <li class="nav-item">
- <a class="nav-link " href="../../www/develop.html">Develop</a>
- </li>
- <li class="nav-item">
- <a class="nav-link" target="_blank" href="https://github.com/ImageMagick/ImageMagick/discussions">Community</a>
- </li>
- <li class="nav-item">
- <iframe src="https://github.com/sponsors/ImageMagick/button" title="Sponsor ImageMagick" height="35" width="107" style="border: 0;"></iframe>
- </li>
- </ul>
- <form class="d-flex form-inline" action="https://imagemagick.org/script/search.php">
- <input class="form-control me-2" type="text" name="q" placeholder="Search" aria-label="Search">
- <button class="btn btn-outline-success" type="submit" name="sa">Search</button>
- </form>
- </div>
- </div>
- </nav>
- <div class="container">
- <script async="async" src="https://localhost/pagead/js/adsbygoogle.js"></script>
- <ins class="adsbygoogle"
- style="display:block"
- data-ad-client="ca-pub-3129977114552745"
- data-ad-slot="6345125851"
- data-full-width-responsive="true"
- data-ad-format="horizontal"></ins>
- <script>
- (adsbygoogle = window.adsbygoogle || []).push({});
- </script>
- </div>
- <main class="container">
- <div class="magick-template">
- <br/>
- <div class="btn-group">
- <button class="btn btn-secondary dropdown-toggle" type="button" id="defaultDropdown" data-bs-toggle="dropdown" data-bs-auto-close="true" aria-expanded="false">
- Select API Method
- </button>
- <ul class="dropdown-menu pre-scrollable" aria-labelledby="defaultDropdown">
- <li><a href="property.html#CloneImageProperties">CloneImageProperties</a></li>
- <li><a href="property.html#DefineImageProperty">DefineImageProperty</a></li>
- <li><a href="property.html#DeleteImageProperty">DeleteImageProperty</a></li>
- <li><a href="property.html#DestroyImageProperties">DestroyImageProperties</a></li>
- <li><a href="property.html#FormatImageProperty">FormatImageProperty</a></li>
- <li><a href="property.html#GetImageProperty">GetImageProperty</a></li>
- <li><a href="property.html#GetNextImageProperty">GetNextImageProperty</a></li>
- <li><a href="property.html#InterpretImageProperties">InterpretImageProperties</a></li>
- <li><a href="property.html#RemoveImageProperty">RemoveImageProperty</a></li>
- <li><a href="property.html#ResetImagePropertyIterator">ResetImagePropertyIterator</a></li>
- </ul>
- </div>
- <br/>
- <br/>
- <div class="magick-header">
- <h2><a href="../../api/MagickCore/property_8c.html" id="CloneImageProperties">CloneImageProperties</a></h2>
- <p>CloneImageProperties() clones all the image properties to another image.</p>
- <p>The format of the CloneImageProperties method is:</p>
- <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType CloneImageProperties(Image *image,
- const Image *clone_image)
- </samp></pre>
- <p>A description of each parameter follows:</p>
- <dd>
- </dd>
- <dd> </dd>
- <dl class="dl-horizontal">
- <dt>image</dt>
- <dd>the image. </dd>
- <dd> </dd>
- <dt>clone_image</dt>
- <dd>the clone image. </dd>
- <dd> </dd>
- </dl>
- <h2><a href="../../api/MagickCore/property_8c.html" id="DefineImageProperty">DefineImageProperty</a></h2>
- <p>DefineImageProperty() associates an assignment string of the form "key=value" with an artifact or options. It is equivalent to SetImageProperty().</p>
- <p>The format of the DefineImageProperty method is:</p>
- <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType DefineImageProperty(Image *image,const char *property,
- ExceptionInfo *exception)
- </samp></pre>
- <p>A description of each parameter follows:</p>
- <dd>
- </dd>
- <dd> </dd>
- <dl class="dl-horizontal">
- <dt>image</dt>
- <dd>the image. </dd>
- <dd> </dd>
- <dt>property</dt>
- <dd>the image property. </dd>
- <dd> </dd>
- <dt>exception</dt>
- <dd>return any errors or warnings in this structure. </dd>
- <dd> </dd>
- </dl>
- <h2><a href="../../api/MagickCore/property_8c.html" id="DeleteImageProperty">DeleteImageProperty</a></h2>
- <p>DeleteImageProperty() deletes an image property.</p>
- <p>The format of the DeleteImageProperty method is:</p>
- <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType DeleteImageProperty(Image *image,const char *property)
- </samp></pre>
- <p>A description of each parameter follows:</p>
- <dd>
- </dd>
- <dd> </dd>
- <dl class="dl-horizontal">
- <dt>image</dt>
- <dd>the image. </dd>
- <dd> </dd>
- <dt>property</dt>
- <dd>the image property. </dd>
- <dd> </dd>
- </dl>
- <h2><a href="../../api/MagickCore/property_8c.html" id="DestroyImageProperties">DestroyImageProperties</a></h2>
- <p>DestroyImageProperties() destroys all properties and associated memory attached to the given image.</p>
- <p>The format of the DestroyDefines method is:</p>
- <pre class="bg-light text-dark mx-4"><samp>void DestroyImageProperties(Image *image)
- </samp></pre>
- <p>A description of each parameter follows:</p>
- <dd>
- </dd>
- <dd> </dd>
- <dl class="dl-horizontal">
- <dt>image</dt>
- <dd>the image. </dd>
- <dd> </dd>
- </dl>
- <h2><a href="../../api/MagickCore/property_8c.html" id="FormatImageProperty">FormatImageProperty</a></h2>
- <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="bg-light text-dark mx-4"><samp>MagickBooleanType FormatImageProperty(Image *image,const char *property,
- const char *format,...)
- </samp></pre>
- <p>A description of each parameter follows.</p>
- <dt> image</dt>
- <p>The image.</p>
- <dt> property</dt>
- <p>The attribute property.</p>
- <dt> format</dt>
- <p>A string describing the format to use to write the remaining arguments.</p>
- <h2><a href="../../api/MagickCore/property_8c.html" id="GetImageProperty">GetImageProperty</a></h2>
- <p>GetImageProperty() gets a value associated with an image property.</p>
- <p>This includes, profile prefixes, such as "exif:", "iptc:" and "8bim:" It does not handle non-profile prefixes, such as "fx:", "option:", or "artifact:".</p>
- <p>The returned string is stored as a prosperity of the same name for faster lookup later. It should NOT be freed by the caller.</p>
- <p>The format of the GetImageProperty method is:</p>
- <pre class="bg-light text-dark mx-4"><samp>const char *GetImageProperty(const Image *image,const char *key,
- ExceptionInfo *exception)
- </samp></pre>
- <p>A description of each parameter follows:</p>
- <dd>
- </dd>
- <dd> </dd>
- <dl class="dl-horizontal">
- <dt>image</dt>
- <dd>the image. </dd>
- <dd> </dd>
- <dt>key</dt>
- <dd>the key. </dd>
- <dd> </dd>
- <dt>exception</dt>
- <dd>return any errors or warnings in this structure. </dd>
- <dd> </dd>
- </dl>
- <h2><a href="../../api/MagickCore/property_8c.html" id="GetNextImageProperty">GetNextImageProperty</a></h2>
- <p>GetNextImageProperty() gets the next free-form string property name.</p>
- <p>The format of the GetNextImageProperty method is:</p>
- <pre class="bg-light text-dark mx-4"><samp>char *GetNextImageProperty(const Image *image)
- </samp></pre>
- <p>A description of each parameter follows:</p>
- <dd>
- </dd>
- <dd> </dd>
- <dl class="dl-horizontal">
- <dt>image</dt>
- <dd>the image. </dd>
- <dd> </dd>
- </dl>
- <h2><a href="../../api/MagickCore/property_8c.html" id="InterpretImageProperties">InterpretImageProperties</a></h2>
- <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 prosperity, 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-expressions' ('*' 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 associated set of properties.</p>
- <p>The returned string must be freed using DestroyString() by the caller.</p>
- <p>The format of the InterpretImageProperties method is:</p>
- <pre class="bg-light text-dark mx-4"><samp>char *InterpretImageProperties(ImageInfo *image_info,
- Image *image,const char *embed_text,ExceptionInfo *exception)
- </samp></pre>
- <p>A description of each parameter follows:</p>
- <dd>
- </dd>
- <dd> </dd>
- <dl class="dl-horizontal">
- <dt>image_info</dt>
- <dd>the image info. (required) </dd>
- <dd> </dd>
- <dt>image</dt>
- <dd>the image. (optional) </dd>
- <dd> </dd>
- <dt>embed_text</dt>
- <dd>the address of a character string containing the embedded formatting characters. </dd>
- <dd> </dd>
- <dt>exception</dt>
- <dd>return any errors or warnings in this structure. </dd>
- <dd> </dd>
- </dl>
- <h2><a href="../../api/MagickCore/property_8c.html" id="RemoveImageProperty">RemoveImageProperty</a></h2>
- <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="bg-light text-dark mx-4"><samp>char *RemoveImageProperty(Image *image,const char *property)
- </samp></pre>
- <p>A description of each parameter follows:</p>
- <dd>
- </dd>
- <dd> </dd>
- <dl class="dl-horizontal">
- <dt>image</dt>
- <dd>the image. </dd>
- <dd> </dd>
- <dt>property</dt>
- <dd>the image property. </dd>
- <dd> </dd>
- </dl>
- <h2><a href="../../api/MagickCore/property_8c.html" id="ResetImagePropertyIterator">ResetImagePropertyIterator</a></h2>
- <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="bg-light text-dark mx-4"><samp>ResetImagePropertyIterator(Image *image)
- </samp></pre>
- <p>A description of each parameter follows:</p>
- <dd>
- </dd>
- <dd> </dd>
- <dl class="dl-horizontal">
- <dt>image</dt>
- <dd>the image. </dd>
- <dd> </dd>
- </dl>
- <h2><a href="../../api/MagickCore/property_8c.html" id="SetImageProperty">SetImageProperty</a></h2>
- <p>SetImageProperty() saves the given string value either to specific known attribute or to a freeform property string.</p>
- <p>Attempting to set a property that is normally calculated will produce an exception.</p>
- <p>The format of the SetImageProperty method is:</p>
- <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType SetImageProperty(Image *image,const char *property,
- const char *value,ExceptionInfo *exception)
- </samp></pre>
- <p>A description of each parameter follows:</p>
- <dd>
- </dd>
- <dd> </dd>
- <dl class="dl-horizontal">
- <dt>image</dt>
- <dd>the image. </dd>
- <dd> </dd>
- <dt>property</dt>
- <dd>the image property. </dd>
- <dd> </dd>
- <dt>values</dt>
- <dd>the image property values. </dd>
- <dd> </dd>
- <dt>exception</dt>
- <dd>return any errors or warnings in this structure. </dd>
- <dd> </dd>
- </dl>
- </div>
- </div>
- </main><!-- /.container -->
- <footer class="magick-footer">
- <div class="container-fluid">
- <a href="../../www/security-policy.html">Security</a> •
- <a href="../../www/news.html">News</a>
-
- <a href="property.html#"><img class="d-inline" id="wand" alt="And Now a Touch of Magick" width="16" height="16" src="../../../images/wand.ico"/></a>
-
- <a href="../../www/links.html">Related</a> •
- <a href="../../www/sitemap.html">Sitemap</a>
- <br/>
- <a href="../../www/support.html">Sponsor</a> •
- <a href="../../www/cite.html">Cite</a> •
- <a href="http://pgp.mit.edu/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> •
- <a href="../../www/contact.html">Contact Us</a>
- <br/>
- <a href="https://github.com/imagemagick/imagemagick" target="_blank" rel="noopener" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 512 499.36" width="2%" height="2%" role="img" focusable="false"><title>GitHub</title><path fill="currentColor" fill-rule="evenodd" d="M256 0C114.64 0 0 114.61 0 256c0 113.09 73.34 209 175.08 242.9 12.8 2.35 17.47-5.56 17.47-12.34 0-6.08-.22-22.18-.35-43.54-71.2 15.49-86.2-34.34-86.2-34.34-11.64-29.57-28.42-37.45-28.42-37.45-23.27-15.84 1.73-15.55 1.73-15.55 25.69 1.81 39.21 26.38 39.21 26.38 22.84 39.12 59.92 27.82 74.5 21.27 2.33-16.54 8.94-27.82 16.25-34.22-56.84-6.43-116.6-28.43-116.6-126.49 0-27.95 10-50.8 26.35-68.69-2.63-6.48-11.42-32.5 2.51-67.75 0 0 21.49-6.88 70.4 26.24a242.65 242.65 0 0 1 128.18 0c48.87-33.13 70.33-26.24 70.33-26.24 14 35.25 5.18 61.27 2.55 67.75 16.41 17.9 26.31 40.75 26.31 68.69 0 98.35-59.85 120-116.88 126.32 9.19 7.9 17.38 23.53 17.38 47.41 0 34.22-.31 61.83-.31 70.23 0 6.85 4.61 14.81 17.6 12.31C438.72 464.97 512 369.08 512 256.02 512 114.62 397.37 0 256 0z"/></svg></a> •
- <a href="https://twitter.com/imagemagick" target="_blank" rel="noopener" aria-label="Twitter"><svg xmlns="http://www.w3.org/2000/svg" class="navbar-nav-svg" viewBox="0 0 300 300" width="2%" height="2%" role="img" focusable="false"><title>Twitter</title><path d="M178.57 127.15 290.27 0h-26.46l-97.03 110.38L89.34 0H0l117.13 166.93L0 300.25h26.46l102.4-116.59 81.8 116.59h89.34M36.01 19.54H76.66l187.13 262.13h-40.66"/></svg></a>
- <br/>
- <small>Copyright © 1999 ImageMagick Studio LLC</small>
- </div>
- </footer>
- <!-- Javascript assets -->
- <script src="../../assets/magick.js" ></script>
- </body>
- </html>
|