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">\r
   4 <head>\r
   5   <meta http-equiv="Content-Type" value="application/xhtml+xml" />\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="screen,projection"><!--\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 href="../../index.html">About ImageMagick</a>
  49 </div>
  50 <div class="sep"></div>\r
  51 <div class="menu">
  52   <a href="../../www/command-line-tools.html">Command-line Tools</a>
  53 </div>
  54 <div class="sub">
  55     <a href="../../www/command-line-processing.html">Processing</a>
  56 </div>
  57 <div class="sub">
  58     <a href="../../www/command-line-options.html">Options</a>
  59 </div>
  60 <div class="sub">
  61     <a href="http://www.imagemagick.org/Usage/">Usage</a>
  62 </div>
  63 <div class="menu">
  64   <a href="../../www/api.html">Program Interfaces</a>
  65 </div>
  66 <div class="sub">
  67     <a href="../../www/magick-wand.html">MagickWand</a>
  68 </div>
  69 <div class="sub">
  70     <a href="../../www/magick-core.html">MagickCore</a>
  71 </div>
  72 <div class="sub">
  73     <a href="../../www/perl-magick.html">PerlMagick</a>
  74 </div>
  75 <div class="sub">
  76     <a href="../../Magick++/">Magick++</a>
  77 </div>
  78 <div class="menu">
  79   <a href="../../www/architecture.html">Architecture</a>
  80 </div>
  81 <div class="sep"></div>\r
  82 <div  class="menu">
  83    <a href="../../www/install-source.html">Install from Source</a>
  84 </div>
  85 <div class="sub">
  86     <a href="../../www/install-source.html#unix">Unix</a>
  87 </div>
  88 <div class="sub">
  89     <a href="../../www/install-source.html#windows">Windows</a>
  90  </div>
  91 <div class="menu">
  92   <a href="../../www/binary-releases.html">Binary Releases</a>
  93 </div>
  94 <div class="sub">
  95     <a href="../../www/binary-releases.html#unix">Unix</a>
  96 </div>
  97 <div class="sub">
  98     <a href="../../www/binary-releases.html#macosx">Mac OS X</a>
  99 </div>
 100 <div class="sub">
 101     <a href="../../www/binary-releases.html#windows">Windows</a>
 102 </div>
 103 <div class="menu">
 104   <a href="../../www/resources.html">Resources</a>
 105 </div>
 106 <div class="sep"></div>\r
 107 <div class="menu">
 108   <a href="../../www/download.html">Download</a>
 109 </div>
 110 <div class="sep"></div>\r
 111 <div class="menu">
 112   <a href="../http://www.imagemagick.org/script/search.php">Search</a>
 113 </div>
 114 <div class="sep"></div>\r
 115 <div class="menu">
 116   <a href="../../www/sitemap.html">Site Map</a>
 117 </div>
 118 <div  class="sub">
 119     <a href="../../www/links.html">Links</a>
 120 </div>
 121 <div class="sep"></div>\r
 122 <div  class="menu">
 123   <a href="../../www/sponsors.html">Sponsors:</a>
 124
 125 <div class="sponsbox">
 126 <div  class="sponsor">
 127    <a href="http://www.geschenke-elsen.de/" title="Lampe Berger">Lampe Berger</a><!-- 20106101000040 -->
 128 </div>
 129 <div  class="sponsor">
 130   <a href="http://www.deko.net">Deko.net</a><!-- 201101010600 Peterssen-->
 131 </div>
 132 <div  class="sponsor">
 133   <a href="http://www.tomsgutscheine.de">Tom's Gutscheine</a><!-- 201005010360 invendio.de-->
 134 </div>
 135 <div  class="sponsor">
 136   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201007010120 Buchhorn -->
 137 </div>
 138 <div  class="sponsor">
 139   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 201005010120 -->
 140 </div>
 141 <div  class="sponsor">
 142   <a href="http://www.print24.de/">Druckerei</a><!-- 201009010720 -->
 143 </div>
 144 <div  class="sponsor">
 145    <a href="http://www.goyax.de">Börse</a><!-- 201004010240 Gewiese digital-finance.de -->
 146 </div>
 147 <div  class="sponsor">
 148    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012011200 allesdruck.de-->
 149 </div>
 150 </div>
 151 </div>
 152 \r
 153 \r
 154 </div>\r
 155 \r
 156 <div class="main">\r
 157 \r
 158 <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>
 159
 160 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 161 _8c.html" target="source" name="DefineImageRegistry">DefineImageRegistry</a></h2>
 162 <div class="doc-section">
 163
 164 <p>DefineImageRegistry() associates a key/value pair with the image registry.</p></ol>
 165
 166 <p>The format of the DefineImageRegistry method is:</p>
 167
 168 <pre class="code">
 169   MagickBooleanType DefineImageRegistry(const RegistryType type,
 170     const char *option,ExceptionInfo *exception)
 171 </pre>
 172
 173 <p>A description of each parameter follows:</p></ol>
 174
 175 <h5>type</h5>
 176 <ol><p>the type.</p></ol>
 177
 178 <h5>option</h5>
 179 <ol><p>the option.</p></ol>
 180
 181 <h5>exception</h5>
 182 <ol><p>the exception.</p></ol>
 183
 184  </div>
 185 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 186 _8c.html" target="source" name="DeleteImageRegistry">DeleteImageRegistry</a></h2>
 187 <div class="doc-section">
 188
 189 <p>DeleteImageRegistry() deletes a key from the image registry.</p></ol>
 190
 191 <p>The format of the DeleteImageRegistry method is:</p>
 192
 193 <pre class="code">
 194   MagickBooleanType DeleteImageRegistry(const char *key)
 195 </pre>
 196
 197 <p>A description of each parameter follows:</p></ol>
 198
 199 <h5>key</h5>
 200 <ol><p>the registry.</p></ol>
 201
 202  </div>
 203 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 204 _8c.html" target="source" name="GetImageRegistry">GetImageRegistry</a></h2>
 205 <div class="doc-section">
 206
 207 <p>GetImageRegistry() returns a value associated with an image registry key.</p></ol>
 208
 209 <p>The format of the GetImageRegistry method is:</p>
 210
 211 <pre class="code">
 212   void *GetImageRegistry(const RegistryType type,const char *key,
 213     ExceptionInfo *exception)
 214 </pre>
 215
 216 <p>A description of each parameter follows:</p></ol>
 217
 218 <h5>type</h5>
 219 <ol><p>the type.</p></ol>
 220
 221 <h5>key</h5>
 222 <ol><p>the key.</p></ol>
 223
 224 <h5>exception</h5>
 225 <ol><p>the exception.</p></ol>
 226
 227  </div>
 228 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 229 _8c.html" target="source" name="GetNextImageRegistry">GetNextImageRegistry</a></h2>
 230 <div class="doc-section">
 231
 232 <p>GetNextImageRegistry() gets the next image registry value.</p></ol>
 233
 234 <p>The format of the GetNextImageRegistry method is:</p>
 235
 236 <pre class="code">
 237   char *GetNextImageRegistry(void)
 238 </pre>
 239
 240  </div>
 241 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 242 _8c.html" target="source" name="RegistryComponentTerminus">RegistryComponentTerminus</a></h2>
 243 <div class="doc-section">
 244
 245 <p>RegistryComponentTerminus() destroys the registry component.</p></ol>
 246
 247 <p>The format of the DestroyDefines method is:</p>
 248
 249 <pre class="code">
 250   void RegistryComponentTerminus(void)
 251 </pre>
 252
 253  </div>
 254 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 255 _8c.html" target="source" name="RemoveImageRegistry">RemoveImageRegistry</a></h2>
 256 <div class="doc-section">
 257
 258 <p>RemoveImageRegistry() removes a key from the image registry and returns its value.</p></ol>
 259
 260 <p>The format of the RemoveImageRegistry method is:</p>
 261
 262 <pre class="code">
 263   void *RemoveImageRegistry(const char *key)
 264 </pre>
 265
 266 <p>A description of each parameter follows:</p></ol>
 267
 268 <h5>key</h5>
 269 <ol><p>the registry.</p></ol>
 270
 271  </div>
 272 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 273 _8c.html" target="source" name="ResetImageRegistryIterator">ResetImageRegistryIterator</a></h2>
 274 <div class="doc-section">
 275
 276 <p>ResetImageRegistryIterator() resets the registry iterator.  Use it in conjunction with GetNextImageRegistry() to iterate over all the values in the image registry.</p></ol>
 277
 278 <p>The format of the ResetImageRegistryIterator method is:</p>
 279
 280 <pre class="code">
 281   ResetImageRegistryIterator(void)
 282 </pre>
 283
 284  </div>
 285 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 286 _8c.html" target="source" name="SetImageRegistry">SetImageRegistry</a></h2>
 287 <div class="doc-section">
 288
 289 <p>SetImageRegistry() associates a value with an image registry key.</p></ol>
 290
 291 <p>The format of the SetImageRegistry method is:</p>
 292
 293 <pre class="code">
 294   MagickBooleanType SetImageRegistry(const RegistryType type,
 295     const char *key,const void *value,ExceptionInfo *exception)
 296 </pre>
 297
 298 <p>A description of each parameter follows:</p></ol>
 299
 300 <h5>type</h5>
 301 <ol><p>the type.</p></ol>
 302
 303 <h5>key</h5>
 304 <ol><p>the key.</p></ol>
 305
 306 <h5>value</h5>
 307 <ol><p>the value.</p></ol>
 308
 309 <h5>exception</h5>
 310 <ol><p>the exception.</p></ol>
 311
 312  </div>
 313 \r
 314 </div>\r
 315 \r
 316 <div id="linkbar">\r
 317  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 318     <span id="linkbar-center">\r
 319       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 320     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 321     </span>\r
 322     <span id="linkbar-east">&nbsp;</span>\r
 323   </div>\r
 324   <div class="footer">\r
 325     <span id="footer-west">&copy; 1999-2010 ImageMagick Studio LLC</span>\r
 326     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 327   </div>\r
 328   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 329 </body>\r
 330 </html>\r