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   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf" />\r
   8   <style type="text/css" media="all">\r
   9     @import url("../../www/magick.css");\r
  10   </style>\r
  11   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/vnd.microsoft.icon"/>
  12   <title>ImageMagick: MagickCore, C API for ImageMagick: The Image Registry</title>
  13   <meta http-equiv="Content-Language" content="en-US"/>
  14   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  15   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  16   <meta name="Generator" content="PHP"/>
  17   <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"/>
  18   <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."/>
  19   <meta name="Rating" content="GENERAL"/>
  20   <meta name="Robots" content="INDEX, FOLLOW"/>
  21   <meta name="Generator" content="ImageMagick Studio LLC"/>
  22   <meta name="Author" content="ImageMagick Studio LLC"/>
  23   <meta name="Revisit-after" content="2 DAYS"/>
  24   <meta name="Resource-type" content="document"/>
  25   <meta name="Copyright" content="Copyright (c) 1999-2010 ImageMagick Studio LLC"/>
  26   <meta name="Distribution" content="Global"/>
  27 </head>\r
  28 \r
  29 <body id="www-imagemagick-org">\r
  30 <div class="titlebar">\r
  31 <a href="../../index.html">\r
  32   <img src="../../images/script.png" alt="[ImageMagick]"\r
  33   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  34 <a href="http://www.networkredux.com">\r
  35   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  36   style="margin: 45px auto; border: 0px; float: left;" /></a>\r
  37 <a href="http://www.imagemagick.org/discourse-server/">\r
  38   <img src="../../images/logo.jpg" alt=""\r
  39   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  40 <a href="../../index.html">\r
  41   <img src="../../images/sprite.jpg" alt=""\r
  42   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  43 </div>\r
  44 \r
  45 <div class="eastbar">\r
  46 \r
  47 <div class="menu">
  48   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  49 </div>
  50 <div class="sep"></div>\r
  51 <div class="menu">
  52   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  53 </div>
  54 <div class="sub">
  55     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  56 </div>
  57 <div class="sub">
  58     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  59 </div>
  60 <div class="sub">
  61     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
  62 </div>
  63 <div class="sep"></div>\r
  64 <div class="menu">
  65   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  66 </div>
  67 <div class="sub">
  68     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  69 </div>
  70 <div class="sub">
  71     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  72 </div>
  73 <div class="sub">
  74     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  75 </div>
  76 <div class="menu">
  77   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
  78 </div>
  79 <div class="sub">
  80     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
  81 </div>
  82 <div class="sub">
  83     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
  84 </div>
  85 <div class="sub">
  86     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
  87 </div>
  88 <div class="sub">
  89     <a title="Program Interface: Magick++" href="../../Magick++/">Magick++</a>
  90 </div>
  91 <div class="sep"></div>\r
  92 <div  class="menu">
  93    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
  94 </div>
  95 <div class="sub">
  96     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
  97 </div>
  98 <div class="sub">
  99     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 100  </div>
 101 <div class="menu">
 102   <a title="Resources" href="../../www/resources.html">Resources</a>
 103 </div>
 104 <div class="menu">
 105   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 106 </div>
 107 <div class="menu">
 108   <a title="Download" href="../../www/download.html">Download</a>
 109 </div>
 110 <div class="sep"></div>\r
 111 <div class="menu">
 112   <a title="Search" href="../http://www.imagemagick.org/script/search.php">Search</a>
 113 </div>
 114 <div class="sep"></div>\r
 115 <div class="menu">
 116   <a title="Site Map"href="../../www/sitemap.html">Site Map</a>
 117 </div>
 118 <div  class="sub">
 119     <a title="Site Map: Links"href="../../www/links.html">Links</a>
 120 </div>
 121 <div class="sep"></div>\r
 122 <div  class="menu">
 123   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 124
 125 <div class="sponsbox">
 126 <div  class="sponsor">
 127   <a title="Sponsor: Webdesign Agentur" href="http://www.ventzke-partner.de">Webdesign Agentur</a><!-- 201101010480 invendio.de-->
 128 </div>
 129 <div  class="sponsor">
 130   <a title="Sponsor: LVM Versicherung" href="http://www.neu-reich.de">LVM Versicherung</a><!-- 201101010480 -->
 131 </div>
 132 <div  class="sponsor">
 133   <a title="Sponsor: Deko.net" href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
 134 </div>
 135 <div  class="sponsor">
 136   <a title="Sponsor: Kredit" href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
 137 </div>
 138 <div  class="sponsor">
 139   <a title="Sponsor: Druckerei" href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 140 </div>
 141 <div  class="sponsor">
 142    <a title="Sponsor: Druckerei Online" href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 143 </div>
 144 <div  class="sponsor">
 145    <a title="Sponsor: Webdesign" href="http://www.renehornig.com/" title="Webdesign">Webdesign</a><!-- 20110101000120 -->
 146 </div>
 147 </div>
 148 </div>
 149 \r
 150 \r
 151 </div>\r
 152 \r
 153 <div class="main">\r
 154 \r
 155 <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>
 156
 157 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 158 _8c.html" target="source" name="DefineImageRegistry">DefineImageRegistry</a></h2>
 159 <div class="doc-section">
 160
 161 <p>DefineImageRegistry() associates a key/value pair with the image registry.</p></ol>
 162
 163 <p>The format of the DefineImageRegistry method is:</p>
 164
 165 <pre class="code">
 166   MagickBooleanType DefineImageRegistry(const RegistryType type,
 167     const char *option,ExceptionInfo *exception)
 168 </pre>
 169
 170 <p>A description of each parameter follows:</p></ol>
 171
 172 <h5>type</h5>
 173 <ol><p>the type.</p></ol>
 174
 175 <h5>option</h5>
 176 <ol><p>the option.</p></ol>
 177
 178 <h5>exception</h5>
 179 <ol><p>the exception.</p></ol>
 180
 181  </div>
 182 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 183 _8c.html" target="source" name="DeleteImageRegistry">DeleteImageRegistry</a></h2>
 184 <div class="doc-section">
 185
 186 <p>DeleteImageRegistry() deletes a key from the image registry.</p></ol>
 187
 188 <p>The format of the DeleteImageRegistry method is:</p>
 189
 190 <pre class="code">
 191   MagickBooleanType DeleteImageRegistry(const char *key)
 192 </pre>
 193
 194 <p>A description of each parameter follows:</p></ol>
 195
 196 <h5>key</h5>
 197 <ol><p>the registry.</p></ol>
 198
 199  </div>
 200 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 201 _8c.html" target="source" name="GetImageRegistry">GetImageRegistry</a></h2>
 202 <div class="doc-section">
 203
 204 <p>GetImageRegistry() returns a value associated with an image registry key.</p></ol>
 205
 206 <p>The format of the GetImageRegistry method is:</p>
 207
 208 <pre class="code">
 209   void *GetImageRegistry(const RegistryType type,const char *key,
 210     ExceptionInfo *exception)
 211 </pre>
 212
 213 <p>A description of each parameter follows:</p></ol>
 214
 215 <h5>type</h5>
 216 <ol><p>the type.</p></ol>
 217
 218 <h5>key</h5>
 219 <ol><p>the key.</p></ol>
 220
 221 <h5>exception</h5>
 222 <ol><p>the exception.</p></ol>
 223
 224  </div>
 225 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 226 _8c.html" target="source" name="GetNextImageRegistry">GetNextImageRegistry</a></h2>
 227 <div class="doc-section">
 228
 229 <p>GetNextImageRegistry() gets the next image registry value.</p></ol>
 230
 231 <p>The format of the GetNextImageRegistry method is:</p>
 232
 233 <pre class="code">
 234   char *GetNextImageRegistry(void)
 235 </pre>
 236
 237  </div>
 238 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 239 _8c.html" target="source" name="RegistryComponentTerminus">RegistryComponentTerminus</a></h2>
 240 <div class="doc-section">
 241
 242 <p>RegistryComponentTerminus() destroys the registry component.</p></ol>
 243
 244 <p>The format of the DestroyDefines method is:</p>
 245
 246 <pre class="code">
 247   void RegistryComponentTerminus(void)
 248 </pre>
 249
 250  </div>
 251 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 252 _8c.html" target="source" name="RemoveImageRegistry">RemoveImageRegistry</a></h2>
 253 <div class="doc-section">
 254
 255 <p>RemoveImageRegistry() removes a key from the image registry and returns its value.</p></ol>
 256
 257 <p>The format of the RemoveImageRegistry method is:</p>
 258
 259 <pre class="code">
 260   void *RemoveImageRegistry(const char *key)
 261 </pre>
 262
 263 <p>A description of each parameter follows:</p></ol>
 264
 265 <h5>key</h5>
 266 <ol><p>the registry.</p></ol>
 267
 268  </div>
 269 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 270 _8c.html" target="source" name="ResetImageRegistryIterator">ResetImageRegistryIterator</a></h2>
 271 <div class="doc-section">
 272
 273 <p>ResetImageRegistryIterator() resets the registry iterator.  Use it in conjunction with GetNextImageRegistry() to iterate over all the values in the image registry.</p></ol>
 274
 275 <p>The format of the ResetImageRegistryIterator method is:</p>
 276
 277 <pre class="code">
 278   ResetImageRegistryIterator(void)
 279 </pre>
 280
 281  </div>
 282 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 283 _8c.html" target="source" name="SetImageRegistry">SetImageRegistry</a></h2>
 284 <div class="doc-section">
 285
 286 <p>SetImageRegistry() associates a value with an image registry key.</p></ol>
 287
 288 <p>The format of the SetImageRegistry method is:</p>
 289
 290 <pre class="code">
 291   MagickBooleanType SetImageRegistry(const RegistryType type,
 292     const char *key,const void *value,ExceptionInfo *exception)
 293 </pre>
 294
 295 <p>A description of each parameter follows:</p></ol>
 296
 297 <h5>type</h5>
 298 <ol><p>the type.</p></ol>
 299
 300 <h5>key</h5>
 301 <ol><p>the key.</p></ol>
 302
 303 <h5>value</h5>
 304 <ol><p>the value.</p></ol>
 305
 306 <h5>exception</h5>
 307 <ol><p>the exception.</p></ol>
 308
 309  </div>
 310 \r
 311 </div>\r
 312 \r
 313 <div id="linkbar">\r
 314  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 315     <span id="linkbar-center">\r
 316       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 317     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 318     </span>\r
 319     <span id="linkbar-east">&nbsp;</span>\r
 320   </div>\r
 321   <div class="footer">\r
 322     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 323     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 324   </div>\r
 325   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 326 </body>\r
 327 </html>\r