1 2 3 4 5 <!DOCTYPE html> 6 <html lang="en"> 7 <head> 8 <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4" /> 9 <title>ImageMagick: MagickCore, C API for ImageMagick: Get/Set Image Properties</title> 10 <meta http-equiv="content-type" content="text/html; charset=utf-8"/> 11 <meta name="application-name" content="ImageMagick"/> 12 <meta name="description" content="ImageMagick is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bzier curves."/> 13 <meta name="application-url" content="http://www.imagemagick.org"/> 14 <meta name="generator" content="PHP"/> 15 <meta name="keywords" content="magickcore, c, api, for, imagemagick:, get/set, image, properties, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert"/> 16 <meta name="rating" content="GENERAL"/> 17 <meta name="robots" content="INDEX, FOLLOW"/> 18 <meta name="generator" content="ImageMagick Studio LLC"/> 19 <meta name="author" content="ImageMagick Studio LLC"/> 20 <meta name="revisit-after" content="2 DAYS"/> 21 <meta name="resource-type" content="document"/> 22 <meta name="copyright" content="Copyright (c) 1999-2016 ImageMagick Studio LLC"/> 23 <meta name="distribution" content="Global"/> 24 <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1"/> 25 <link rel="icon" href="../image/wand.png"/> 26 <link rel="shortcut icon" href="../image/wand.ico"/> 27 <link rel="stylesheet" href="../css/magick.php"/> 28 </head> 29 <body> 30 <div class="main"> 31 <div class="magick-masthead"> 32 <div class="container"> 33 <script async="async" src="http://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script> <ins class="adsbygoogle" 34 style="display:block" 35 data-ad-client="ca-pub-3129977114552745" 36 data-ad-slot="6345125851" 37 data-ad-format="auto"></ins> 38 <script> 39 (adsbygoogle = window.adsbygoogle || []).push({}); 40 </script> 41 <nav class="magick-nav"> 42 <a class="magick-nav-item " href="../index.php">Home</a> 43 <a class="magick-nav-item " href="../script/binary-releases.php">Download</a> 44 <a class="magick-nav-item " href="../script/command-line-tools.php">Tools</a> 45 <a class="magick-nav-item " href="../script/command-line-options.php">Options</a> 46 <a class="magick-nav-item " href="../script/resources.php">Resources</a> 47 <a class="magick-nav-item " href="../script/api.php">Develop</a> 48 <a class="magick-nav-item " href="../script/search.php">Search</a> 49 <a class="magick-nav-item pull-right" href="http://www.imagemagick.org/discourse-server/">Community</a> 50 </nav> 51 </div> 52 </div> 53 <div class="container"> 54 <div class="magick-header"> 55 <p class="text-center"><a href="property.php#CloneImageProperties">CloneImageProperties</a> • <a href="property.php#DefineImageProperty">DefineImageProperty</a> • <a href="property.php#DeleteImageProperty">DeleteImageProperty</a> • <a href="property.php#DestroyImageProperties">DestroyImageProperties</a> • <a href="property.php#FormatImageProperty">FormatImageProperty</a> • <a href="property.php#GetImageProperty">GetImageProperty</a> • <a href="property.php#GetNextImageProperty">GetNextImageProperty</a> • <a href="property.php#InterpretImageProperties">InterpretImageProperties</a> • <a href="property.php#(void) LogMagickEvent(TraceEvent,GetMagickModule">(void) LogMagickEvent(TraceEvent,GetMagickModule</a> • <a href="property.php#RemoveImageProperty">RemoveImageProperty</a> • <a href="property.php#ResetImagePropertyIterator">ResetImagePropertyIterator</a> • <a href="property.php#SetImageProperty">SetImageProperty</a></p> 56 57 <h2><a href="http://nextgen.imagemagick.org/api/MagickCore/property_8c.html" id="CloneImageProperties">CloneImageProperties</a></h2> 58 59 <p>CloneImageProperties() clones all the image properties to another image.</p> 60 61 <p>The format of the CloneImageProperties method is:</p> 62 63 <pre class="text"> 64 MagickBooleanType CloneImageProperties(Image *image, 65 const Image *clone_image) 66 </pre> 67 68 <p>A description of each parameter follows:</p> 69 70 <dd> 71 </dd> 72 73 <dd> </dd> 74 <dl class="dl-horizontal"> 75 <dt>image</dt> 76 <dd>the image. </dd> 77 78 <dd> </dd> 79 <dt>clone_image</dt> 80 <dd>the clone image. </dd> 81 82 <dd> </dd> 83 </dl> 84 <h2><a href="http://nextgen.imagemagick.org/api/MagickCore/property_8c.html" id="DefineImageProperty">DefineImageProperty</a></h2> 85 86 <p>DefineImageProperty() associates an assignment string of the form "key=value" with an artifact or options. It is equivelent to SetImageProperty()</p> 87 88 <p>The format of the DefineImageProperty method is:</p> 89 90 <pre class="text"> 91 MagickBooleanType DefineImageProperty(Image *image,const char *property, 92 ExceptionInfo *exception) 93 </pre> 94 95 <p>A description of each parameter follows:</p> 96 97 <dd> 98 </dd> 99 100 <dd> </dd> 101 <dl class="dl-horizontal"> 102 <dt>image</dt> 103 <dd>the image. </dd> 104 105 <dd> </dd> 106 <dt>property</dt> 107 <dd>the image property. </dd> 108 109 <dd> </dd> 110 <dt>exception</dt> 111 <dd>return any errors or warnings in this structure. </dd> 112 113 <dd> </dd> 114 </dl> 115 <h2><a href="http://nextgen.imagemagick.org/api/MagickCore/property_8c.html" id="DeleteImageProperty">DeleteImageProperty</a></h2> 116 117 <p>DeleteImageProperty() deletes an image property.</p> 118 119 <p>The format of the DeleteImageProperty method is:</p> 120 121 <pre class="text"> 122 MagickBooleanType DeleteImageProperty(Image *image,const char *property) 123 </pre> 124 125 <p>A description of each parameter follows:</p> 126 127 <dd> 128 </dd> 129 130 <dd> </dd> 131 <dl class="dl-horizontal"> 132 <dt>image</dt> 133 <dd>the image. </dd> 134 135 <dd> </dd> 136 <dt>property</dt> 137 <dd>the image property. </dd> 138 139 <dd> </dd> 140 </dl> 141 <h2><a href="http://nextgen.imagemagick.org/api/MagickCore/property_8c.html" id="DestroyImageProperties">DestroyImageProperties</a></h2> 142 143 <p>DestroyImageProperties() destroys all properties and associated memory attached to the given image.</p> 144 145 <p>The format of the DestroyDefines method is:</p> 146 147 <pre class="text"> 148 void DestroyImageProperties(Image *image) 149 </pre> 150 151 <p>A description of each parameter follows:</p> 152 153 <dd> 154 </dd> 155 156 <dd> </dd> 157 <dl class="dl-horizontal"> 158 <dt>image</dt> 159 <dd>the image. </dd> 160 161 <dd> </dd> 162 </dl> 163 <h2><a href="http://nextgen.imagemagick.org/api/MagickCore/property_8c.html" id="FormatImageProperty">FormatImageProperty</a></h2> 164 165 <p>FormatImageProperty() permits formatted property/value pairs to be saved as an image property.</p> 166 167 <p>The format of the FormatImageProperty method is:</p> 168 169 <pre class="text"> 170 MagickBooleanType FormatImageProperty(Image *image,const char *property, 171 const char *format,...) 172 </pre> 173 174 <p>A description of each parameter follows.</p> 175 176 <dt> image</dt> 177 <p>The image.</p> 178 179 <dt> property</dt> 180 <p>The attribute property.</p> 181 182 <dt> format</dt> 183 <p>A string describing the format to use to write the remaining arguments.</p> 184 185 <h2><a href="http://nextgen.imagemagick.org/api/MagickCore/property_8c.html" id="GetImageProperty">GetImageProperty</a></h2> 186 187 <p>GetImageProperty() gets a value associated with an image property.</p> 188 189 <p>This includes, profile prefixes, such as "exif:", "iptc:" and "8bim:" It does not handle non-prifile prefixes, such as "fx:", "option:", or "artifact:".</p> 190 191 <p>The returned string is stored as a properity of the same name for faster lookup later. It should NOT be freed by the caller.</p> 192 193 <p>The format of the GetImageProperty method is:</p> 194 195 <pre class="text"> 196 const char *GetImageProperty(const Image *image,const char *key, 197 ExceptionInfo *exception) 198 </pre> 199 200 <p>A description of each parameter follows:</p> 201 202 <dd> 203 </dd> 204 205 <dd> </dd> 206 <dl class="dl-horizontal"> 207 <dt>image</dt> 208 <dd>the image. </dd> 209 210 <dd> </dd> 211 <dt>key</dt> 212 <dd>the key. </dd> 213 214 <dd> </dd> 215 <dt>exception</dt> 216 <dd>return any errors or warnings in this structure. </dd> 217 218 <dd> </dd> 219 </dl> 220 <h2><a href="http://nextgen.imagemagick.org/api/MagickCore/property_8c.html" id="GetNextImageProperty">GetNextImageProperty</a></h2> 221 222 <p>GetNextImageProperty() gets the next free-form string property name.</p> 223 224 <p>The format of the GetNextImageProperty method is:</p> 225 226 <pre class="text"> 227 char *GetNextImageProperty(const Image *image) 228 </pre> 229 230 <p>A description of each parameter follows:</p> 231 232 <dd> 233 </dd> 234 235 <dd> </dd> 236 <dl class="dl-horizontal"> 237 <dt>image</dt> 238 <dd>the image. </dd> 239 240 <dd> </dd> 241 </dl> 242 <h2><a href="http://nextgen.imagemagick.org/api/MagickCore/property_8c.html" id="InterpretImageProperties">InterpretImageProperties</a></h2> 243 244 <p>InterpretImageProperties() replaces any embedded formatting characters with the appropriate image property and returns the interpreted text.</p> 245 246 <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> 247 248 <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> 249 250 <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> 251 252 <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 properties.</p> 253 254 <p>The returned string must be freed using DestoryString() by the caller.</p> 255 256 <p>The format of the InterpretImageProperties method is:</p> 257 258 <pre class="text"> 259 char *InterpretImageProperties(ImageInfo *image_info, 260 Image *image,const char *embed_text,ExceptionInfo *exception) 261 </pre> 262 263 <p>A description of each parameter follows:</p> 264 265 <dd> 266 </dd> 267 268 <dd> </dd> 269 <dl class="dl-horizontal"> 270 <dt>image_info</dt> 271 <dd>the image info. (required) </dd> 272 273 <dd> </dd> 274 <dt>image</dt> 275 <dd>the image. (optional) </dd> 276 277 <dd> </dd> 278 <dt>embed_text</dt> 279 <dd>the address of a character string containing the embedded formatting characters. </dd> 280 281 <dd> </dd> 282 <dt>exception</dt> 283 <dd>return any errors or warnings in this structure. </dd> 284 285 <dd> </dd> 286 </dl> 287 <h2><a href="http://nextgen.imagemagick.org/api/MagickCore/property_8c.html" id="(void)_LogMagickEvent(TraceEvent,GetMagickModule">(void) LogMagickEvent(TraceEvent,GetMagickModule</a></h2> 288 289 <p>(void) LogMagickEvent(TraceEvent,GetMagickModule(),"s",image->filename); else if( image_info != (ImageInfo *) NULL && IfMagickTrue(image_info->debug)) (void) LogMagickEvent(TraceEvent,GetMagickModule(),"s","no-image");</p> 290 291 <p>if (embed_text == (const char *) NULL) return(ConstantString("")); p=embed_text;</p> 292 293 <p>if (*p == '\0') return(ConstantString(""));</p> 294 295 <p>if ((*p == '@') && (IsPathAccessible(p+1) != MagickFalse)) { /* handle a '@' replace string from file */ interpret_text=FileToString(p+1,~0UL,exception); if (interpret_text != (char *) NULL) return(interpret_text); }</p> 296 297 <p>/* Translate any embedded format characters. </p> 298 <h2><a href="http://nextgen.imagemagick.org/api/MagickCore/property_8c.html" id="RemoveImageProperty">RemoveImageProperty</a></h2> 299 300 <p>RemoveImageProperty() removes a property from the image and returns its value.</p> 301 302 <p>In this case the ConstantString() value returned should be freed by the caller when finished.</p> 303 304 <p>The format of the RemoveImageProperty method is:</p> 305 306 <pre class="text"> 307 char *RemoveImageProperty(Image *image,const char *property) 308 </pre> 309 310 <p>A description of each parameter follows:</p> 311 312 <dd> 313 </dd> 314 315 <dd> </dd> 316 <dl class="dl-horizontal"> 317 <dt>image</dt> 318 <dd>the image. </dd> 319 320 <dd> </dd> 321 <dt>property</dt> 322 <dd>the image property. </dd> 323 324 <dd> </dd> 325 </dl> 326 <h2><a href="http://nextgen.imagemagick.org/api/MagickCore/property_8c.html" id="ResetImagePropertyIterator">ResetImagePropertyIterator</a></h2> 327 328 <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> 329 330 <p>The format of the ResetImagePropertyIterator method is:</p> 331 332 <pre class="text"> 333 ResetImagePropertyIterator(Image *image) 334 </pre> 335 336 <p>A description of each parameter follows:</p> 337 338 <dd> 339 </dd> 340 341 <dd> </dd> 342 <dl class="dl-horizontal"> 343 <dt>image</dt> 344 <dd>the image. </dd> 345 346 <dd> </dd> 347 </dl> 348 <h2><a href="http://nextgen.imagemagick.org/api/MagickCore/property_8c.html" id="SetImageProperty">SetImageProperty</a></h2> 349 350 <p>SetImageProperty() saves the given string value either to specific known attribute or to a freeform property string.</p> 351 352 <p>Attempting to set a property that is normally calculated will produce an exception.</p> 353 354 <p>The format of the SetImageProperty method is:</p> 355 356 <pre class="text"> 357 MagickBooleanType SetImageProperty(Image *image,const char *property, 358 const char *value,ExceptionInfo *exception) 359 </pre> 360 361 <p>A description of each parameter follows:</p> 362 363 <dd> 364 </dd> 365 366 <dd> </dd> 367 <dl class="dl-horizontal"> 368 <dt>image</dt> 369 <dd>the image. </dd> 370 371 <dd> </dd> 372 <dt>property</dt> 373 <dd>the image property. </dd> 374 375 <dd> </dd> 376 <dt>values</dt> 377 <dd>the image property values. </dd> 378 379 <dd> </dd> 380 <dt>exception</dt> 381 <dd>return any errors or warnings in this structure. </dd> 382 383 <dd> </dd> 384 </dl> 385 </div> 386 <footer class="magick-footer"> 387 <p><a href="../script/support.php">Donate</a> 388 <a href="../script/sitemap.php">Sitemap</a> 389 <a href="../script/links.php">Related</a> 390 <a href="../script/architecture.php">Architecture</a> 391 </p> 392 <p><a href="property.php#">Back to top</a> 393 <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> 394 <a href="../script/contact.php">Contact Us</a></p> 395 <p><small> 1999-2016 ImageMagick Studio LLC</small></p> 396 </footer> 397 </div><!-- /.container --> 398 399 <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.3/jquery.min.js"></script> 400 <script src="http://nextgen.imagemagick.org/js/magick.php"></script> 401 </div> 402 </body> 403 </html> 404
