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.goyax.de">Börse</a><!-- 201001000240 Gewiese digital-finance.de -->
 127 </div>
 128 <div  class="sponsor">
 129    <a href="http://www.allesdruck.de">Druckerei Online</a><!-- 201012001200 allesdruck.de-->
 130 </div>
 131 <div  class="sponsor">
 132   <a href="http://www.blumenversender.com">Blumenversand</a><!-- 200911010120 -->
 133 </div>
 134 <div  class="sponsor">
 135   <a href="http://www.print24.de/">Druckerei</a><!-- 200911010480 -->
 136 </div>
 137 <div  class="sponsor">
 138   <a href="http://www.who-sells-it.com/">Free Catalogs</a><!-- 201002010000 -->
 139 </div>
 140 <div  class="sponsor">
 141   <a href="http://www.online-kredit-index.de">Kredit</a><!-- 201002010120 Buchhorn -->
 142 </div>
 143 </div>
 144 </div>
 145 \r
 146 \r
 147 </div>\r
 148 \r
 149 <div class="main">\r
 150 \r
 151 <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>
 152
 153 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 154 _8c.html" target="source" name="DefineImageRegistry">DefineImageRegistry</a></h2>
 155 <div class="doc-section">
 156
 157 <p>DefineImageRegistry() associates a key/value pair with the image registry.</p></ol>
 158
 159 <p>The format of the DefineImageRegistry method is:</p>
 160
 161 <pre class="code">
 162   MagickBooleanType DefineImageRegistry(const RegistryType type,
 163     const char *option,ExceptionInfo *exception)
 164 </pre>
 165
 166 <p>A description of each parameter follows:</p></ol>
 167
 168 <h5>type</h5>
 169 <ol><p>the type.</p></ol>
 170
 171 <h5>option</h5>
 172 <ol><p>the option.</p></ol>
 173
 174 <h5>exception</h5>
 175 <ol><p>the exception.</p></ol>
 176
 177  </div>
 178 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 179 _8c.html" target="source" name="DeleteImageRegistry">DeleteImageRegistry</a></h2>
 180 <div class="doc-section">
 181
 182 <p>DeleteImageRegistry() deletes a key from the image registry.</p></ol>
 183
 184 <p>The format of the DeleteImageRegistry method is:</p>
 185
 186 <pre class="code">
 187   MagickBooleanType DeleteImageRegistry(const char *key)
 188 </pre>
 189
 190 <p>A description of each parameter follows:</p></ol>
 191
 192 <h5>key</h5>
 193 <ol><p>the registry.</p></ol>
 194
 195  </div>
 196 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 197 _8c.html" target="source" name="DestroyImageRegistry">DestroyImageRegistry</a></h2>
 198 <div class="doc-section">
 199
 200 <p>DestroyImageRegistry() releases memory associated with the image registry.</p></ol>
 201
 202 <p>The format of the DestroyDefines method is:</p>
 203
 204 <pre class="code">
 205   void DestroyImageRegistry(void)
 206 </pre>
 207
 208  </div>
 209 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 210 _8c.html" target="source" name="GetImageRegistry">GetImageRegistry</a></h2>
 211 <div class="doc-section">
 212
 213 <p>GetImageRegistry() returns a value associated with an image registry key.</p></ol>
 214
 215 <p>The format of the GetImageRegistry method is:</p>
 216
 217 <pre class="code">
 218   void *GetImageRegistry(const RegistryType type,const char *key,
 219     ExceptionInfo *exception)
 220 </pre>
 221
 222 <p>A description of each parameter follows:</p></ol>
 223
 224 <h5>type</h5>
 225 <ol><p>the type.</p></ol>
 226
 227 <h5>key</h5>
 228 <ol><p>the key.</p></ol>
 229
 230 <h5>exception</h5>
 231 <ol><p>the exception.</p></ol>
 232
 233  </div>
 234 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 235 _8c.html" target="source" name="GetNextImageRegistry">GetNextImageRegistry</a></h2>
 236 <div class="doc-section">
 237
 238 <p>GetNextImageRegistry() gets the next image registry value.</p></ol>
 239
 240 <p>The format of the GetNextImageRegistry method is:</p>
 241
 242 <pre class="code">
 243   char *GetNextImageRegistry(void)
 244 </pre>
 245
 246  </div>
 247 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 248 _8c.html" target="source" name="RemoveImageRegistry">RemoveImageRegistry</a></h2>
 249 <div class="doc-section">
 250
 251 <p>RemoveImageRegistry() removes a key from the image registry and returns its value.</p></ol>
 252
 253 <p>The format of the RemoveImageRegistry method is:</p>
 254
 255 <pre class="code">
 256   void *RemoveImageRegistry(const char *key)
 257 </pre>
 258
 259 <p>A description of each parameter follows:</p></ol>
 260
 261 <h5>key</h5>
 262 <ol><p>the registry.</p></ol>
 263
 264  </div>
 265 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 266 _8c.html" target="source" name="ResetImageRegistryIterator">ResetImageRegistryIterator</a></h2>
 267 <div class="doc-section">
 268
 269 <p>ResetImageRegistryIterator() resets the registry iterator.  Use it in conjunction with GetNextImageRegistry() to iterate over all the values in the image registry.</p></ol>
 270
 271 <p>The format of the ResetImageRegistryIterator method is:</p>
 272
 273 <pre class="code">
 274   ResetImageRegistryIterator(void)
 275 </pre>
 276
 277  </div>
 278 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry
 279 _8c.html" target="source" name="SetImageRegistry">SetImageRegistry</a></h2>
 280 <div class="doc-section">
 281
 282 <p>SetImageRegistry() associates a value with an image registry key.</p></ol>
 283
 284 <p>The format of the SetImageRegistry method is:</p>
 285
 286 <pre class="code">
 287   MagickBooleanType SetImageRegistry(const RegistryType type,
 288     const char *key,const void *value,ExceptionInfo *exception)
 289 </pre>
 290
 291 <p>A description of each parameter follows:</p></ol>
 292
 293 <h5>type</h5>
 294 <ol><p>the type.</p></ol>
 295
 296 <h5>key</h5>
 297 <ol><p>the key.</p></ol>
 298
 299 <h5>value</h5>
 300 <ol><p>the value.</p></ol>
 301
 302 <h5>exception</h5>
 303 <ol><p>the exception.</p></ol>
 304
 305  </div>
 306 \r
 307 </div>\r
 308 \r
 309 <div id="linkbar">\r
 310  <!--    <span id="linkbar-west">&nbsp;</span>  -->\r
 311     <span id="linkbar-center">\r
 312       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 313       <a href="../../www/mailing-list.html">Mailing Lists</a> &bull;\r
 314     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 315     </span>\r
 316     <span id="linkbar-east">&nbsp;</span>\r
 317   </div>\r
 318   <div class="footer">\r
 319     <span id="footer-west">&copy; 1999-2009 ImageMagick Studio LLC</span>\r
 320     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 321   </div>\r
 322   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 323 </body>\r
 324 </html>\r