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