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