granicus.if.org Git - imagemagick/blob - www/api/registry.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" \r
   2   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">\r
   3 <html xmlns="http://www.w3.org/1999/xhtml" xml: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   <title>ImageMagick: MagickCore, C API for ImageMagick: The Image Registry</title>
   8   <meta http-equiv="Content-Language" content="en-US"/>
   9   <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  10   <meta http-equiv="Reply-to" content="magick-users@imagemagick.org"/>
  11   <meta name="Application-name" content="ImageMagick"/>
  12   <meta name="Description" content="ImageMagick is a software suite to create, edit, compose, or convert bitmap images in a variety of formats. Use ImageMagick to scale, rotate, shear, distort and transform images."/>
  13   <meta name="Application-url" content="http://www.imagemagick.org"/>
  14   <meta name="Generator" content="PHP"/>
  15   <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"/>
  16   <meta name="Rating" content="GENERAL"/>
  17   <meta name="Robots" content="INDEX, FOLLOW"/>
  18   <meta name="Generator" content="ImageMagick Studio LLC"/>
  19   <meta name="Author" content="ImageMagick Studio LLC"/>
  20   <meta name="Revisit-after" content="2 DAYS"/>
  21   <meta name="Resource-type" content="document"/>
  22   <meta name="Copyright" content="Copyright (c) 1999-2011 ImageMagick Studio LLC"/>
  23   <meta name="Distribution" content="Global"/>
  24   <link rel="icon" href="../../images/wand.png"/>
  25   <link rel="shortcut icon" href="../../images/wand.ico"  type="images/x-icon"/>
  26   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
  27   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />\r
  28   <style type="text/css" media="all">\r
  29     @import url("../../www/magick.css");\r
  30   </style>\r
  31   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4/jquery.min.js"></script>\r
  32   <script type="text/javascript" src="../fancybox/jquery.fancybox-1.3.4.pack.js"></script>\r
  33   <link rel="stylesheet" type="text/css" href="../fancybox/jquery.fancybox-1.3.4.css" media="screen" />\r
  34   <script type="text/javascript">\r
  35     $(document).ready(function() {\r
  36       $("a[href$=.jpg],a[href$=.png],a[href$=.gif]").fancybox({\r
  37         'transitionIn'  : 'elastic',\r
  38         'transitionOut' : 'elastic',\r
  39         'overlayShow'   : false,\r
  40         'opacity'       : true\r
  41       });\r
  42     });\r
  43   </script>\r
  44 </head>\r
  45 \r
  46 <body id="www-imagemagick-org">\r
  47 <div class="titlebar">\r
  48 <a href="../../index.html">\r
  49   <img src="../../images/script.png" alt="[ImageMagick]"\r
  50   style="width: 350px; height: 60px; margin: 28px auto; float: left;" /></a>\r
  51 <a href="http://www.networkredux.com">\r
  52   <img src="../../images/networkredux.png" alt="[sponsor]"\r
  53   style="margin-top: 42px; border: 0px; float: left;" /></a>\r
  54 <a href="http://www.imagemagick.org/discourse-server/">\r
  55   <img src="../../images/logo.jpg" alt=""\r
  56   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>\r
  57 <a href="../../index.html">\r
  58   <img src="../../images/sprite.jpg" alt=""\r
  59   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  60 </div>\r
  61 \r
  62 <div class="westbar">\r
  63 \r
  64 <div class="menu">
  65   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
  66 </div>
  67 <div class="sep"></div>\r
  68 <div class="menu">
  69   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
  70 </div>
  71 <div class="sub">
  72     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
  73 </div>
  74 <div class="sub">
  75     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
  76 </div>
  77 <div class="sub">
  78     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
  79 </div>
  80 <div class="sep"></div>\r
  81 <div class="menu">
  82   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
  83 </div>
  84 <div class="sub">
  85     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
  86 </div>
  87 <div class="sub">
  88     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
  89 </div>
  90 <div class="sub">
  91     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
  92 </div>
  93 <div class="menu">
  94   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
  95 </div>
  96 <div class="sub">
  97     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
  98 </div>
  99 <div class="sub">
 100     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
 101 </div>
 102 <div class="sub">
 103     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
 104 </div>
 105 <div class="sub">
 106     <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
 107 </div>
 108 <div class="sep"></div>\r
 109 <div  class="menu">
 110    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
 111 </div>
 112 <div class="sub">
 113     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
 114 </div>
 115 <div class="sub">
 116     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 117  </div>
 118 <div class="menu">
 119   <a title="Resources" href="../../www/resources.html">Resources</a>
 120 </div>
 121 <div class="menu">
 122   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 123 </div>
 124 <div class="menu">
 125   <a title="Download" href="../../www/download.html">Download</a>
 126 </div>
 127 <div class="sep"></div>\r
 128 <div class="menu">
 129   <a title="Search" href="../../www/search.html">Search</a>
 130 </div>
 131 <div class="sep"></div>\r
 132 <div class="menu">
 133   <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
 134 </div>
 135 <div  class="sub">
 136   <a title="Site Map: Links" href="../../www/links.html">Links</a>
 137 </div>
 138 <div class="sep"></div>\r
 139 <div  class="menu">
 140   <a title="Sponsors" href="../../www/sponsors.html">Sponsors:</a>
 141
 142 <div class="sponsbox">
 143 <div  class="sponsor">
 144   <a title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201106010240 -->
 145 </div>
 146 <div class="sponsor">
 147   <a title="Sponsor: Web Hosting" href="http://www.bodhost.com/hosting.shtml">Web Hosting</a><!-- 201104010090 -->
 148 </div>
 149 <div  class="sponsor">
 150   <a title="Sponsor: Image Converter" href="http://www.batchphoto.com">Image Converter</a><!-- 201103010900 Bits Coffee-->
 151 </div>
 152 <div  class="sponsor">
 153   <a title="Sponsor: Flyer drucken" href="http://www.online-druck.biz">Flyer drucken</a><!-- 201109010900 Floeter-->
 154 </div>
 155 <div  class="sponsor">
 156   <a title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 201110010720 -->
 157 </div>
 158 <div  class="sponsor">
 159    <a title="Sponsor: alaTest.com" href="http://alatest.com">alaTest.com</a><!-- 20110801000300 -->
 160 </div>
 161 </div>
 162 </div>
 163 </div>\r
 164 \r
 165 <div class="eastbar">\r
 166   <script type="text/javascript">\r
 167   <!--\r
 168     google_ad_client = "pub-3129977114552745";\r
 169     google_ad_slot = "0574824969";\r
 170     google_ad_width = 160;\r
 171     google_ad_height = 600;\r
 172   //-->\r
 173   </script>\r
 174   <script type="text/javascript"\r
 175     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
 176   </script>\r
 177 </div>\r
 178 \r
 179 <div class="main">\r
 180 \r
 181 <h1>Module registry
 182  Methods</h1>
 183 <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>
 184
 185 <h2><a href="http://www.wizards-toolkit.org/api/MagickCore/registry
 186 _8c.html" id="DefineImageRegistry">DefineImageRegistry</a></h2>
 187 <div class="doc-section">
 188
 189 <p>DefineImageRegistry() associates a key/value pair with the image registry.</p>
 190
 191 <p>The format of the DefineImageRegistry method is:</p>
 192
 193 <pre class="code">
 194   MagickBooleanType DefineImageRegistry(const RegistryType type,
 195     const char *option,ExceptionInfo *exception)
 196 </pre>
 197
 198 <p>A description of each parameter follows:</p>
 199
 200 <h5>type</h5>
 201 <p>the type.</p>
 202
 203 <h5>option</h5>
 204 <p>the option.</p>
 205
 206 <h5>exception</h5>
 207 <p>the exception.</p>
 208
 209  </div>
 210 <h2><a href="http://www.wizards-toolkit.org/api/MagickCore/registry
 211 _8c.html" id="DeleteImageRegistry">DeleteImageRegistry</a></h2>
 212 <div class="doc-section">
 213
 214 <p>DeleteImageRegistry() deletes a key from the image registry.</p>
 215
 216 <p>The format of the DeleteImageRegistry method is:</p>
 217
 218 <pre class="code">
 219   MagickBooleanType DeleteImageRegistry(const char *key)
 220 </pre>
 221
 222 <p>A description of each parameter follows:</p>
 223
 224 <h5>key</h5>
 225 <p>the registry.</p>
 226
 227  </div>
 228 <h2><a href="http://www.wizards-toolkit.org/api/MagickCore/registry
 229 _8c.html" id="GetImageRegistry">GetImageRegistry</a></h2>
 230 <div class="doc-section">
 231
 232 <p>GetImageRegistry() returns a value associated with an image registry key.</p>
 233
 234 <p>The format of the GetImageRegistry method is:</p>
 235
 236 <pre class="code">
 237   void *GetImageRegistry(const RegistryType type,const char *key,
 238     ExceptionInfo *exception)
 239 </pre>
 240
 241 <p>A description of each parameter follows:</p>
 242
 243 <h5>type</h5>
 244 <p>the type.</p>
 245
 246 <h5>key</h5>
 247 <p>the key.</p>
 248
 249 <h5>exception</h5>
 250 <p>the exception.</p>
 251
 252  </div>
 253 <h2><a href="http://www.wizards-toolkit.org/api/MagickCore/registry
 254 _8c.html" id="GetNextImageRegistry">GetNextImageRegistry</a></h2>
 255 <div class="doc-section">
 256
 257 <p>GetNextImageRegistry() gets the next image registry value.</p>
 258
 259 <p>The format of the GetNextImageRegistry method is:</p>
 260
 261 <pre class="code">
 262   char *GetNextImageRegistry(void)
 263 </pre>
 264
 265  </div>
 266 <h2><a href="http://www.wizards-toolkit.org/api/MagickCore/registry
 267 _8c.html" id="RegistryComponentTerminus">RegistryComponentTerminus</a></h2>
 268 <div class="doc-section">
 269
 270 <p>RegistryComponentTerminus() destroys the registry component.</p>
 271
 272 <p>The format of the DestroyDefines method is:</p>
 273
 274 <pre class="code">
 275   void RegistryComponentTerminus(void)
 276 </pre>
 277
 278  </div>
 279 <h2><a href="http://www.wizards-toolkit.org/api/MagickCore/registry
 280 _8c.html" id="RemoveImageRegistry">RemoveImageRegistry</a></h2>
 281 <div class="doc-section">
 282
 283 <p>RemoveImageRegistry() removes a key from the image registry and returns its value.</p>
 284
 285 <p>The format of the RemoveImageRegistry method is:</p>
 286
 287 <pre class="code">
 288   void *RemoveImageRegistry(const char *key)
 289 </pre>
 290
 291 <p>A description of each parameter follows:</p>
 292
 293 <h5>key</h5>
 294 <p>the registry.</p>
 295
 296  </div>
 297 <h2><a href="http://www.wizards-toolkit.org/api/MagickCore/registry
 298 _8c.html" id="ResetImageRegistryIterator">ResetImageRegistryIterator</a></h2>
 299 <div class="doc-section">
 300
 301 <p>ResetImageRegistryIterator() resets the registry iterator.  Use it in conjunction with GetNextImageRegistry() to iterate over all the values in the image registry.</p>
 302
 303 <p>The format of the ResetImageRegistryIterator method is:</p>
 304
 305 <pre class="code">
 306   ResetImageRegistryIterator(void)
 307 </pre>
 308
 309  </div>
 310 <h2><a href="http://www.wizards-toolkit.org/api/MagickCore/registry
 311 _8c.html" id="SetImageRegistry">SetImageRegistry</a></h2>
 312 <div class="doc-section">
 313
 314 <p>SetImageRegistry() associates a value with an image registry key.</p>
 315
 316 <p>The format of the SetImageRegistry method is:</p>
 317
 318 <pre class="code">
 319   MagickBooleanType SetImageRegistry(const RegistryType type,
 320     const char *key,const void *value,ExceptionInfo *exception)
 321 </pre>
 322
 323 <p>A description of each parameter follows:</p>
 324
 325 <h5>type</h5>
 326 <p>the type.</p>
 327
 328 <h5>key</h5>
 329 <p>the key.</p>
 330
 331 <h5>value</h5>
 332 <p>the value.</p>
 333
 334 <h5>exception</h5>
 335 <p>the exception.</p>
 336
 337  </div>
 338 \r
 339 </div>\r
 340 \r
 341 <div id="linkbar">\r
 342     <span id="linkbar-west">&nbsp;</span>\r
 343     <span id="linkbar-center">\r
 344       <a href="http://www.imagemagick.org/discourse-server/">Discourse Server</a> &bull;\r
 345       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 346     </span>\r
 347     <span id="linkbar-east">&nbsp;</span>\r
 348   </div>\r
 349   <div class="footer">\r
 350     <span id="footer-west">&copy; 1999-2011 ImageMagick Studio LLC</span>\r
 351     <span id="footer-east"> <a href="../http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 352   </div>\r
 353   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 354   <script type="text/javascript">\r
 355     var _gaq = _gaq || [];\r
 356     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 357     _gaq.push(['_trackPageview']);\r
 358 \r
 359     (function() {\r
 360       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 361       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 362       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 363     })();\r
 364   </script>\r
 365 </body>\r
 366 </html>\r