granicus.if.org Git - imagemagick/blob - www/api/registry.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"\r
   2     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en" dir="ltr">\r
   4 <head>\r
   5   <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>\r
   6   <meta name="verify-v1" content="g222frIIxcQTrvDR3NBRUSKP3AnMNoqxOkIniCEkV7U="/>\r
   7   <title>ImageMagick: MagickCore, C API for ImageMagick: The Image Registry</title/>
   8   <meta http-equiv="Content-Language" content="en-US"/>
   9   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  10   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  11   <meta name="Application-name" content="ImageMagick"/>
  12   <meta name="Description" content="ImageMagick® is a software suite to create, edit, and compose bitmap images. It can read, convert and write images in a variety of formats (about 100) including GIF, JPEG, JPEG-2000, PNG, PDF, PhotoCD, TIFF, and DPX. Use ImageMagick to translate, flip, mirror, rotate, scale, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.  ImageMagick is free software delivered as a ready-to-run binary distribution or as source code that you can freely use, copy, modify, and distribute. Its license is compatible with the GPL. It runs on all major operating systems.  The functionality of ImageMagick is typically utilized from the command line or you can use the features from programs written in your favorite programming language. Choose from these interfaces: MagickCore (C), MagickWand (C), ChMagick (Ch), Magick++ (C++), JMagick (Java), L-Magick (Lisp), PascalMagick (Pascal), PerlMagick (Perl), MagickWand for PHP (PHP), PythonMagick (Python), RMagick (Ruby), or TclMagick (Tcl/TK). With a language interface, use ImageMagick to modify or create images automagically and dynamically."/>
  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:, the, image, registry, ImageMagick, ImageMagic, MagickCore, MagickWand, PerlMagick, Magick++, RMagick, PythonMagick, JMagick, TclMagick, Image, Magick, Magic, Wand, ImageMagickObject, Swiss, Army, Knife, Image, Processing"/>
  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-2010 ImageMagick Studio LLC"/>
  23   <meta name="Distribution" content="Global"/>
  24   <link rel="icon" href="../../images/wand.png"  sizes="32x32"/>
  25   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/x-icon"/>
  26   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
  27   <style type="text/css" media="all">\r
  28     @import url("../../www/magick.css");\r
  29   </style>\r
  30 </head>\r
  31 \r
  32 <body id="www-imagemagick-org">\r
  33 <div class="titlebar">\r
  34 <a href="../../index.html">\r
  35   <img src="../../images/script.png" alt="[ImageMagick]"\r
  36   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  37 <a href="http://www.networkredux.com">\r
  38   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  39   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  40 <a href="http://www.imagemagick.org/discourse-server/">\r
  41   <img src="../../images/logo.jpg" alt=""\r
  42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  43 <a href="../../index.html">\r
  44   <img src="../../images/sprite.jpg" alt=""\r
  45   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  46 </div>\r
  47 \r
  48 <div class="westbar">\r
  49 \r
  50 <div class="menu">
  51   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  52 </div>
  53 <div class="sep"></div>\r
  54 <div class="menu">
  55   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  56 </div>
  57 <div class="sub">
  58     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  59 </div>
  60 <div class="sub">
  61     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  62 </div>
  63 <div class="sub">
  64     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
  65 </div>
  66 <div class="sep"></div>\r
  67 <div class="menu">
  68   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  69 </div>
  70 <div class="sub">
  71     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  72 </div>
  73 <div class="sub">
  74     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  75 </div>
  76 <div class="sub">
  77     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  78 </div>
  79 <div class="menu">
  80   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
  81 </div>
  82 <div class="sub">
  83     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
  84 </div>
  85 <div class="sub">
  86     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
  87 </div>
  88 <div class="sub">
  89     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
  90 </div>
  91 <div class="sub">
  92     <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
  93 </div>
  94 <div class="sep"></div>\r
  95 <div  class="menu">
  96    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
  97 </div>
  98 <div class="sub">
  99     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
 100 </div>
 101 <div class="sub">
 102     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 103  </div>
 104 <div class="menu">
 105   <a title="Resources" href="../../www/resources.html">Resources</a>
 106 </div>
 107 <div class="menu">
 108   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 109 </div>
 110 <div class="menu">
 111   <a title="Download" href="../../www/download.html">Download</a>
 112 </div>
 113 <div class="sep"></div>\r
 114 <div class="menu">
 115   <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
 116 </div>
 117 <div class="sep"></div>\r
 118 <div class="menu">
 119   <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
 120 </div>
 121 <div  class="sub">
 122     <a title="Site Map: Links"href="../../www/links.html">Links</a>
 123 </div>
 124 <div class="sep"></div>\r
 125 <div  class="menu">
 126   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 127
 128 <div class="sponsbox">
 129 <div  class="sponsor">
 130    <a title="Sponsor: Online-Magazin" href="http://www.unkostenbeitrag.de/">Online-Magazin</a><!-- 20101101000200 -->
 131 </div>
 132 <div  class="sponsor">
 133   <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 134 </div>
 135 <div  class="sponsor">
 136   <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
 137 </div>
 138 <div  class="sponsor">
 139   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 140 </div>
 141 <div  class="sponsor">
 142   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 143 </div>
 144 <div  class="sponsor">
 145   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 146 </div>
 147 <div  class="sponsor">
 148   <a title="Sponsor: Diamonds are a Girls Best Friend" href="http://www.schmuck.org">Diamonds are a Girls Best Friend</a><!-- 201101010600 Peterssen-->
 149 </div>
 150 <div  class="sponsor">
 151    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 152 </div>
 153 </div>
 154 </div>
 155 </div>\r
 156 \r
 157 <div class="eastbar">\r
 158   <script type="text/javascript">\r
 159   <!--\r
 160     google_ad_client = "pub-3129977114552745";\r
 161     google_ad_slot = "0574824969";\r
 162     google_ad_width = 160;\r
 163     google_ad_height = 600;\r
 164   //-->\r
 165   </script>\r
 166   <script type="text/javascript"\r
 167     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 168   </script>\r
 169 </div>\r
 170 \r
 171 <div class="main">\r
 172 \r
 173 <p class="navigation-index">[<a href="#DefineImageRegistry">DefineImageRegistry</a> &bull; <a href="#DeleteImageRegistry">DeleteImageRegistry</a> &bull; <a href="#GetImageRegistry">GetImageRegistry</a> &bull; <a href="#GetNextImageRegistry">GetNextImageRegistry</a> &bull; <a href="#RegistryComponentTerminus">RegistryComponentTerminus</a> &bull; <a href="#RemoveImageRegistry">RemoveImageRegistry</a> &bull; <a href="#ResetImageRegistryIterator">ResetImageRegistryIterator</a> &bull; <a href="#SetImageRegistry">SetImageRegistry</a>]</p>
 174
 175 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 176 _8c.html" target="source" name="DefineImageRegistry">DefineImageRegistry</a></h2>
 177 <div class="doc-section">
 178
 179 <p>DefineImageRegistry() associates a key/value pair with the image registry.</p></ol>
 180
 181 <p>The format of the DefineImageRegistry method is:</p>
 182
 183 <pre class="code">
 184   MagickBooleanType DefineImageRegistry(const RegistryType type,
 185     const char *option,ExceptionInfo *exception)
 186 </pre>
 187
 188 <p>A description of each parameter follows:</p></ol>
 189
 190 <h5>type</h5>
 191 <ol><p>the type.</p></ol>
 192
 193 <h5>option</h5>
 194 <ol><p>the option.</p></ol>
 195
 196 <h5>exception</h5>
 197 <ol><p>the exception.</p></ol>
 198
 199  </div>
 200 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 201 _8c.html" target="source" name="DeleteImageRegistry">DeleteImageRegistry</a></h2>
 202 <div class="doc-section">
 203
 204 <p>DeleteImageRegistry() deletes a key from the image registry.</p></ol>
 205
 206 <p>The format of the DeleteImageRegistry method is:</p>
 207
 208 <pre class="code">
 209   MagickBooleanType DeleteImageRegistry(const char *key)
 210 </pre>
 211
 212 <p>A description of each parameter follows:</p></ol>
 213
 214 <h5>key</h5>
 215 <ol><p>the registry.</p></ol>
 216
 217  </div>
 218 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 219 _8c.html" target="source" name="GetImageRegistry">GetImageRegistry</a></h2>
 220 <div class="doc-section">
 221
 222 <p>GetImageRegistry() returns a value associated with an image registry key.</p></ol>
 223
 224 <p>The format of the GetImageRegistry method is:</p>
 225
 226 <pre class="code">
 227   void *GetImageRegistry(const RegistryType type,const char *key,
 228     ExceptionInfo *exception)
 229 </pre>
 230
 231 <p>A description of each parameter follows:</p></ol>
 232
 233 <h5>type</h5>
 234 <ol><p>the type.</p></ol>
 235
 236 <h5>key</h5>
 237 <ol><p>the key.</p></ol>
 238
 239 <h5>exception</h5>
 240 <ol><p>the exception.</p></ol>
 241
 242  </div>
 243 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 244 _8c.html" target="source" name="GetNextImageRegistry">GetNextImageRegistry</a></h2>
 245 <div class="doc-section">
 246
 247 <p>GetNextImageRegistry() gets the next image registry value.</p></ol>
 248
 249 <p>The format of the GetNextImageRegistry method is:</p>
 250
 251 <pre class="code">
 252   char *GetNextImageRegistry(void)
 253 </pre>
 254
 255  </div>
 256 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 257 _8c.html" target="source" name="RegistryComponentTerminus">RegistryComponentTerminus</a></h2>
 258 <div class="doc-section">
 259
 260 <p>RegistryComponentTerminus() destroys the registry component.</p></ol>
 261
 262 <p>The format of the DestroyDefines method is:</p>
 263
 264 <pre class="code">
 265   void RegistryComponentTerminus(void)
 266 </pre>
 267
 268  </div>
 269 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 270 _8c.html" target="source" name="RemoveImageRegistry">RemoveImageRegistry</a></h2>
 271 <div class="doc-section">
 272
 273 <p>RemoveImageRegistry() removes a key from the image registry and returns its value.</p></ol>
 274
 275 <p>The format of the RemoveImageRegistry method is:</p>
 276
 277 <pre class="code">
 278   void *RemoveImageRegistry(const char *key)
 279 </pre>
 280
 281 <p>A description of each parameter follows:</p></ol>
 282
 283 <h5>key</h5>
 284 <ol><p>the registry.</p></ol>
 285
 286  </div>
 287 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 288 _8c.html" target="source" name="ResetImageRegistryIterator">ResetImageRegistryIterator</a></h2>
 289 <div class="doc-section">
 290
 291 <p>ResetImageRegistryIterator() resets the registry iterator.  Use it in conjunction with GetNextImageRegistry() to iterate over all the values in the image registry.</p></ol>
 292
 293 <p>The format of the ResetImageRegistryIterator method is:</p>
 294
 295 <pre class="code">
 296   ResetImageRegistryIterator(void)
 297 </pre>
 298
 299  </div>
 300 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 301 _8c.html" target="source" name="SetImageRegistry">SetImageRegistry</a></h2>
 302 <div class="doc-section">
 303
 304 <p>SetImageRegistry() associates a value with an image registry key.</p></ol>
 305
 306 <p>The format of the SetImageRegistry method is:</p>
 307
 308 <pre class="code">
 309   MagickBooleanType SetImageRegistry(const RegistryType type,
 310     const char *key,const void *value,ExceptionInfo *exception)
 311 </pre>
 312
 313 <p>A description of each parameter follows:</p></ol>
 314
 315 <h5>type</h5>
 316 <ol><p>the type.</p></ol>
 317
 318 <h5>key</h5>
 319 <ol><p>the key.</p></ol>
 320
 321 <h5>value</h5>
 322 <ol><p>the value.</p></ol>
 323
 324 <h5>exception</h5>
 325 <ol><p>the exception.</p></ol>
 326
 327  </div>
 328 \r
 329 </div>\r
 330 \r
 331 <div id="linkbar">\r
 332     <span id="linkbar-west">&nbsp;</span>\r
 333     <span id="linkbar-center">\r
 334       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 335       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 336     </span>\r
 337     <span id="linkbar-east">&nbsp;</span>\r
 338   </div>\r
 339   <div class="footer">\r
 340     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 341     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 342   </div>\r
 343   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 344   <script type="text/javascript">\r
 345     var _gaq = _gaq || [];\r
 346     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 347     _gaq.push(['_trackPageview']);\r
 348 \r
 349     (function() {\r
 350       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 351       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 352       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 353     })();\r
 354   </script>\r
 355 </body>\r
 356 </html>\r