property.html 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445
  1. <!doctype html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8" />
  5. <meta name="viewport" content="width=device-width, initial-scale=1" />
  6. <title>ImageMagick – MagickCore, C API: Get/Set Image Properties</title>
  7. <meta name="application-name" content="ImageMagick" />
  8. <meta name="description" content="" />
  9. <meta name="application-url" content="https://imagemagick.org" />
  10. <meta name="generator" content="PHP" />
  11. <meta name="keywords" content="magickcore, c, api:, get/set, image, properties, image processing software" />
  12. <meta name="rating" content="GENERAL" />
  13. <meta name="robots" content="INDEX, FOLLOW" />
  14. <meta name="generator" content="ImageMagick Studio LLC" />
  15. <meta name="author" content="ImageMagick Studio LLC" />
  16. <meta name="revisit-after" content="2 DAYS" />
  17. <meta name="resource-type" content="document" />
  18. <meta name="copyright" content="Copyright (c) 1999 ImageMagick Studio LLC" />
  19. <meta name="distribution" content="Global" />
  20. <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1" />
  21. <meta property='og:url' content='../../' />
  22. <meta property='og:title' content='ImageMagick' />
  23. <meta property='og:image' content='../../../images/logo.png' />
  24. <meta property='og:type' content='website' />
  25. <meta property='og:site_name' content='ImageMagick' />
  26. <meta property='og:description' content="Create, Edit, Compose, or Convert Digital Images" />
  27. <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" />
  28. <link href="property.html" rel="canonical" />
  29. <link href="../../../images/wand.png" rel="icon" />
  30. <link href="../../../images/wand.ico" rel="shortcut icon" />
  31. <link href="../../assets/magick.css" rel="stylesheet" />
  32. </head>
  33. <body>
  34. <nav class="navbar navbar-expand-md navbar-dark bg-dark fixed-top">
  35. <div class="container-fluid">
  36. <a class="navbar-brand" href="../../"><img class="d-block" id="icon" alt="ImageMagick" width="32" height="32" src="../../../images/wand.ico"/></a>
  37. <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">
  38. <span class="navbar-toggler-icon"></span>
  39. </button>
  40. <div class="collapse navbar-collapse" id="magick-navbars">
  41. <ul class="navbar-nav me-auto mb-2 mb-md-0">
  42. <li class="nav-item">
  43. <a class="nav-link " href="../../www/download.html">Download</a>
  44. </li>
  45. <li class="nav-item">
  46. <a class="nav-link " href="../../www/command-line-tools.html">Tools</a>
  47. </li>
  48. <li class="nav-item">
  49. <a class="nav-link " href="../../www/command-line-processing.html">CLI</a>
  50. </li>
  51. <li class="nav-item">
  52. <a class="nav-link " href="../../www/develop.html">Develop</a>
  53. </li>
  54. <li class="nav-item">
  55. <a class="nav-link" target="_blank" href="https://github.com/ImageMagick/ImageMagick/discussions">Community</a>
  56. </li>
  57. <li class="nav-item">
  58. <iframe src="https://github.com/sponsors/ImageMagick/button" title="Sponsor ImageMagick" height="35" width="107" style="border: 0;"></iframe>
  59. </li>
  60. </ul>
  61. <form class="d-flex form-inline" action="https://imagemagick.org/script/search.php">
  62. <input class="form-control me-2" type="text" name="q" placeholder="Search" aria-label="Search">
  63. <button class="btn btn-outline-success" type="submit" name="sa">Search</button>
  64. </form>
  65. </div>
  66. </div>
  67. </nav>
  68. <div class="container">
  69. <script async="async" src="https://localhost/pagead/js/adsbygoogle.js"></script>
  70. <ins class="adsbygoogle"
  71. style="display:block"
  72. data-ad-client="ca-pub-3129977114552745"
  73. data-ad-slot="6345125851"
  74. data-full-width-responsive="true"
  75. data-ad-format="horizontal"></ins>
  76. <script>
  77. (adsbygoogle = window.adsbygoogle || []).push({});
  78. </script>
  79. </div>
  80. <main class="container">
  81. <div class="magick-template">
  82. <br/>
  83. <div class="btn-group">
  84. <button class="btn btn-secondary dropdown-toggle" type="button" id="defaultDropdown" data-bs-toggle="dropdown" data-bs-auto-close="true" aria-expanded="false">
  85. Select API Method
  86. </button>
  87. <ul class="dropdown-menu pre-scrollable" aria-labelledby="defaultDropdown">
  88. <li><a href="property.html#CloneImageProperties">CloneImageProperties</a></li>
  89. <li><a href="property.html#DefineImageProperty">DefineImageProperty</a></li>
  90. <li><a href="property.html#DeleteImageProperty">DeleteImageProperty</a></li>
  91. <li><a href="property.html#DestroyImageProperties">DestroyImageProperties</a></li>
  92. <li><a href="property.html#FormatImageProperty">FormatImageProperty</a></li>
  93. <li><a href="property.html#GetImageProperty">GetImageProperty</a></li>
  94. <li><a href="property.html#GetNextImageProperty">GetNextImageProperty</a></li>
  95. <li><a href="property.html#InterpretImageProperties">InterpretImageProperties</a></li>
  96. <li><a href="property.html#RemoveImageProperty">RemoveImageProperty</a></li>
  97. <li><a href="property.html#ResetImagePropertyIterator">ResetImagePropertyIterator</a></li>
  98. </ul>
  99. </div>
  100. <br/>
  101. <br/>
  102. <div class="magick-header">
  103. <h2><a href="../../api/MagickCore/property_8c.html" id="CloneImageProperties">CloneImageProperties</a></h2>
  104. <p>CloneImageProperties() clones all the image properties to another image.</p>
  105. <p>The format of the CloneImageProperties method is:</p>
  106. <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType CloneImageProperties(Image *image,
  107. const Image *clone_image)
  108. </samp></pre>
  109. <p>A description of each parameter follows:</p>
  110. <dd>
  111. </dd>
  112. <dd> </dd>
  113. <dl class="dl-horizontal">
  114. <dt>image</dt>
  115. <dd>the image. </dd>
  116. <dd> </dd>
  117. <dt>clone_image</dt>
  118. <dd>the clone image. </dd>
  119. <dd> </dd>
  120. </dl>
  121. <h2><a href="../../api/MagickCore/property_8c.html" id="DefineImageProperty">DefineImageProperty</a></h2>
  122. <p>DefineImageProperty() associates an assignment string of the form "key=value" with an artifact or options. It is equivalent to SetImageProperty().</p>
  123. <p>The format of the DefineImageProperty method is:</p>
  124. <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType DefineImageProperty(Image *image,const char *property,
  125. ExceptionInfo *exception)
  126. </samp></pre>
  127. <p>A description of each parameter follows:</p>
  128. <dd>
  129. </dd>
  130. <dd> </dd>
  131. <dl class="dl-horizontal">
  132. <dt>image</dt>
  133. <dd>the image. </dd>
  134. <dd> </dd>
  135. <dt>property</dt>
  136. <dd>the image property. </dd>
  137. <dd> </dd>
  138. <dt>exception</dt>
  139. <dd>return any errors or warnings in this structure. </dd>
  140. <dd> </dd>
  141. </dl>
  142. <h2><a href="../../api/MagickCore/property_8c.html" id="DeleteImageProperty">DeleteImageProperty</a></h2>
  143. <p>DeleteImageProperty() deletes an image property.</p>
  144. <p>The format of the DeleteImageProperty method is:</p>
  145. <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType DeleteImageProperty(Image *image,const char *property)
  146. </samp></pre>
  147. <p>A description of each parameter follows:</p>
  148. <dd>
  149. </dd>
  150. <dd> </dd>
  151. <dl class="dl-horizontal">
  152. <dt>image</dt>
  153. <dd>the image. </dd>
  154. <dd> </dd>
  155. <dt>property</dt>
  156. <dd>the image property. </dd>
  157. <dd> </dd>
  158. </dl>
  159. <h2><a href="../../api/MagickCore/property_8c.html" id="DestroyImageProperties">DestroyImageProperties</a></h2>
  160. <p>DestroyImageProperties() destroys all properties and associated memory attached to the given image.</p>
  161. <p>The format of the DestroyDefines method is:</p>
  162. <pre class="bg-light text-dark mx-4"><samp>void DestroyImageProperties(Image *image)
  163. </samp></pre>
  164. <p>A description of each parameter follows:</p>
  165. <dd>
  166. </dd>
  167. <dd> </dd>
  168. <dl class="dl-horizontal">
  169. <dt>image</dt>
  170. <dd>the image. </dd>
  171. <dd> </dd>
  172. </dl>
  173. <h2><a href="../../api/MagickCore/property_8c.html" id="FormatImageProperty">FormatImageProperty</a></h2>
  174. <p>FormatImageProperty() permits formatted property/value pairs to be saved as an image property.</p>
  175. <p>The format of the FormatImageProperty method is:</p>
  176. <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType FormatImageProperty(Image *image,const char *property,
  177. const char *format,...)
  178. </samp></pre>
  179. <p>A description of each parameter follows.</p>
  180. <dt> image</dt>
  181. <p>The image.</p>
  182. <dt> property</dt>
  183. <p>The attribute property.</p>
  184. <dt> format</dt>
  185. <p>A string describing the format to use to write the remaining arguments.</p>
  186. <h2><a href="../../api/MagickCore/property_8c.html" id="GetImageProperty">GetImageProperty</a></h2>
  187. <p>GetImageProperty() gets a value associated with an image property.</p>
  188. <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>
  189. <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>
  190. <p>The format of the GetImageProperty method is:</p>
  191. <pre class="bg-light text-dark mx-4"><samp>const char *GetImageProperty(const Image *image,const char *key,
  192. ExceptionInfo *exception)
  193. </samp></pre>
  194. <p>A description of each parameter follows:</p>
  195. <dd>
  196. </dd>
  197. <dd> </dd>
  198. <dl class="dl-horizontal">
  199. <dt>image</dt>
  200. <dd>the image. </dd>
  201. <dd> </dd>
  202. <dt>key</dt>
  203. <dd>the key. </dd>
  204. <dd> </dd>
  205. <dt>exception</dt>
  206. <dd>return any errors or warnings in this structure. </dd>
  207. <dd> </dd>
  208. </dl>
  209. <h2><a href="../../api/MagickCore/property_8c.html" id="GetNextImageProperty">GetNextImageProperty</a></h2>
  210. <p>GetNextImageProperty() gets the next free-form string property name.</p>
  211. <p>The format of the GetNextImageProperty method is:</p>
  212. <pre class="bg-light text-dark mx-4"><samp>char *GetNextImageProperty(const Image *image)
  213. </samp></pre>
  214. <p>A description of each parameter follows:</p>
  215. <dd>
  216. </dd>
  217. <dd> </dd>
  218. <dl class="dl-horizontal">
  219. <dt>image</dt>
  220. <dd>the image. </dd>
  221. <dd> </dd>
  222. </dl>
  223. <h2><a href="../../api/MagickCore/property_8c.html" id="InterpretImageProperties">InterpretImageProperties</a></h2>
  224. <p>InterpretImageProperties() replaces any embedded formatting characters with the appropriate image property and returns the interpreted text.</p>
  225. <p>This searches for and replaces \n \r \ replaced by newline, return, and percent resp. &amp;lt; &amp;gt; &amp;amp; replaced by '&lt;', '&gt;', '&amp;' resp. replaced by percent</p>
  226. <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>
  227. <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>
  228. <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>
  229. <p>The returned string must be freed using DestroyString() by the caller.</p>
  230. <p>The format of the InterpretImageProperties method is:</p>
  231. <pre class="bg-light text-dark mx-4"><samp>char *InterpretImageProperties(ImageInfo *image_info,
  232. Image *image,const char *embed_text,ExceptionInfo *exception)
  233. </samp></pre>
  234. <p>A description of each parameter follows:</p>
  235. <dd>
  236. </dd>
  237. <dd> </dd>
  238. <dl class="dl-horizontal">
  239. <dt>image_info</dt>
  240. <dd>the image info. (required) </dd>
  241. <dd> </dd>
  242. <dt>image</dt>
  243. <dd>the image. (optional) </dd>
  244. <dd> </dd>
  245. <dt>embed_text</dt>
  246. <dd>the address of a character string containing the embedded formatting characters. </dd>
  247. <dd> </dd>
  248. <dt>exception</dt>
  249. <dd>return any errors or warnings in this structure. </dd>
  250. <dd> </dd>
  251. </dl>
  252. <h2><a href="../../api/MagickCore/property_8c.html" id="RemoveImageProperty">RemoveImageProperty</a></h2>
  253. <p>RemoveImageProperty() removes a property from the image and returns its value.</p>
  254. <p>In this case the ConstantString() value returned should be freed by the caller when finished.</p>
  255. <p>The format of the RemoveImageProperty method is:</p>
  256. <pre class="bg-light text-dark mx-4"><samp>char *RemoveImageProperty(Image *image,const char *property)
  257. </samp></pre>
  258. <p>A description of each parameter follows:</p>
  259. <dd>
  260. </dd>
  261. <dd> </dd>
  262. <dl class="dl-horizontal">
  263. <dt>image</dt>
  264. <dd>the image. </dd>
  265. <dd> </dd>
  266. <dt>property</dt>
  267. <dd>the image property. </dd>
  268. <dd> </dd>
  269. </dl>
  270. <h2><a href="../../api/MagickCore/property_8c.html" id="ResetImagePropertyIterator">ResetImagePropertyIterator</a></h2>
  271. <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>
  272. <p>The format of the ResetImagePropertyIterator method is:</p>
  273. <pre class="bg-light text-dark mx-4"><samp>ResetImagePropertyIterator(Image *image)
  274. </samp></pre>
  275. <p>A description of each parameter follows:</p>
  276. <dd>
  277. </dd>
  278. <dd> </dd>
  279. <dl class="dl-horizontal">
  280. <dt>image</dt>
  281. <dd>the image. </dd>
  282. <dd> </dd>
  283. </dl>
  284. <h2><a href="../../api/MagickCore/property_8c.html" id="SetImageProperty">SetImageProperty</a></h2>
  285. <p>SetImageProperty() saves the given string value either to specific known attribute or to a freeform property string.</p>
  286. <p>Attempting to set a property that is normally calculated will produce an exception.</p>
  287. <p>The format of the SetImageProperty method is:</p>
  288. <pre class="bg-light text-dark mx-4"><samp>MagickBooleanType SetImageProperty(Image *image,const char *property,
  289. const char *value,ExceptionInfo *exception)
  290. </samp></pre>
  291. <p>A description of each parameter follows:</p>
  292. <dd>
  293. </dd>
  294. <dd> </dd>
  295. <dl class="dl-horizontal">
  296. <dt>image</dt>
  297. <dd>the image. </dd>
  298. <dd> </dd>
  299. <dt>property</dt>
  300. <dd>the image property. </dd>
  301. <dd> </dd>
  302. <dt>values</dt>
  303. <dd>the image property values. </dd>
  304. <dd> </dd>
  305. <dt>exception</dt>
  306. <dd>return any errors or warnings in this structure. </dd>
  307. <dd> </dd>
  308. </dl>
  309. </div>
  310. </div>
  311. </main><!-- /.container -->
  312. <footer class="magick-footer">
  313. <div class="container-fluid">
  314. <a href="../../www/security-policy.html">Security</a> •
  315. <a href="../../www/news.html">News</a>
  316. <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>
  317. <a href="../../www/links.html">Related</a> •
  318. <a href="../../www/sitemap.html">Sitemap</a>
  319. <br/>
  320. <a href="../../www/support.html">Sponsor</a> •
  321. <a href="../../www/cite.html">Cite</a> •
  322. <a href="http://pgp.mit.edu/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a> •
  323. <a href="../../www/contact.html">Contact Us</a>
  324. <br/>
  325. <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> •
  326. <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>
  327. <br/>
  328. <small>Copyright © 1999 ImageMagick Studio LLC</small>
  329. </div>
  330. </footer>
  331. <!-- Javascript assets -->
  332. <script src="../../assets/magick.js" ></script>
  333. </body>
  334. </html>