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 version="-//W3C//DTD XHTML 1.1//EN"\r
   4       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"\r
   5       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"\r
   6       xsi:schemaLocation="http://www.w3.org/1999/xhtml\r
   7                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">\r
   8 <head>\r
   9   <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>\r
  10   <meta name="google-site-verification" content="MxsMq6bdLOx0KSuz1MY6yG9ZTIJ7_7DVRfl5NCAT5Yg"/>\r
  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="application-name" content="ImageMagick"/>
  16   <meta name="description" content="Use ImageMagick to convert, edit, or compose bitmap images in a variety of formats.  In addition resize, rotate, shear, distort and transform images automagically."/>
  17   <meta name="application-url" content="http://www.imagemagick.org"/>
  18   <meta name="generator" content="PHP"/>
  19   <meta name="keywords" content="magickcore, c, api, for, imagemagick:, the, image, registry, ImageMagick, PerlMagick, image processing, OpenMP, software development library, image, photo, software, Magick++, MagickWand"/>
  20   <meta name="rating" content="GENERAL"/>
  21   <meta name="robots" content="INDEX, FOLLOW"/>
  22   <meta name="generator" content="ImageMagick Studio LLC"/>
  23   <meta name="author" content="ImageMagick Studio LLC"/>
  24   <meta name="revisit-after" content="2 DAYS"/>
  25   <meta name="resource-type" content="document"/>
  26   <meta name="copyright" content="Copyright (c) 1999-2012 ImageMagick Studio LLC"/>
  27   <meta name="distribution" content="Global"/>
  28   <link rel="icon" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/wand.png"/>
  29   <link rel="shortcut icon" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/wand.ico"  type="images/x-icon"/>
  30   <link rel="canonical" href="http://www.imagemagick.org" />\r
  31   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>\r
  32   <!-- Add jQuery library -->\r
  33   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>\r
  34   \r
  35   <!-- Optionaly include easing and/or mousewheel plugins -->\r
  36   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.easing-1.3.pack.js"></script>\r
  37   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.mousewheel-3.0.6.pack.js"></script>\r
  38   \r
  39   <!-- Add fancyBox -->\r
  40   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/jquery.fancybox.css?v=2.0.4" type="text/css" media="screen" />\r
  41   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/jquery.fancybox.pack.js?v=2.0.4"></script>\r
  42   \r
  43   <!-- Optionaly include button and/or thumbnail helpers -->\r
  44   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.css?v=2.0.4" type="text/css" media="screen" />\r
  45   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-buttons.js?v=2.0.4"></script>\r
  46   \r
  47   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.css?v=2.0.4" type="text/css" media="screen" />\r
  48   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/helpers/jquery.fancybox-thumbs.js?v=2.0.4"></script>\r
  49   <script type="text/javascript">\r
  50         $(document).ready(function() {\r
  51                 $(".fancybox").fancybox();\r
  52         });\r
  53   </script>\r
  54   <!-- ImageMagick style -->\r
  55   <link rel="stylesheet" href="http://www.google.com/cse/style/look/default.css" type="text/css" />\r
  56   <style type="text/css" media="all">\r
  57     @import url("../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick.css");\r
  58   </style>\r
  59 </head>\r
  60 \r
  61 <body id="www-imagemagick-org">\r
  62 <div class="titlebar">\r
  63 <div style="margin: 17px auto; float: left;">\r
  64   <script type="text/javascript">\r
  65   <!--\r
  66     google_ad_client = "pub-3129977114552745";\r
  67     google_ad_slot = "5439289906";\r
  68     google_ad_width = 728;\r
  69     google_ad_height = 90;\r
  70   //-->\r
  71   </script>\r
  72   <script type="text/javascript"\r
  73     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">\r
  74   </script>\r
  75 </div>\r
  76 <a href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../discourse-server">\r
  77   <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/logo.jpg"\r
  78   alt="ImageMagick Logo"\r
  79   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>\r
  80 <a href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../index.html">\r
  81   <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/sprite.jpg"\r
  82   alt="ImageMagick Sprite"\r
  83   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>\r
  84 </div>\r
  85 \r
  86 <div class="westbar">\r
  87 \r
  88 <div class="menu">
  89   <a title="About ImageMagick" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../index.html">About ImageMagick</a>
  90 </div>
  91 <div class="menu">
  92   <a title="Binary Releases" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html">Binary Releases</a>
  93 </div>
  94 <div class="sub">
  95     <a title="Binary Release: Unix" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#unix">Unix</a>
  96 </div>
  97 <div class="sub">
  98     <a title="Binary Release: MacOS X" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#macosx">Mac OS X</a>
  99 </div>
 100 <div class="sub">
 101     <a title="Binary Release: iOS" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#iOS">iOS</a>
 102 </div>
 103 <div class="sub">
 104     <a title="Binary Release: Windows" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/binary-releases.html#windows">Windows</a>
 105 </div>
 106 <div class="sep"></div>\r
 107 <div class="menu">
 108   <a title="Command-line Tools" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/command-line-tools.html">Command-line Tools</a>
 109 </div>
 110 <div class="sub">
 111     <a title="Command-line Tools: Processing" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/command-line-processing.html">Processing</a>
 112 </div>
 113 <div class="sub">
 114     <a title="Command-line Tools: Options" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/command-line-options.html">Options</a>
 115 </div>
 116 <div class="sub">
 117     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 118 </div>
 119 <div class="menu">
 120   <a title="Program Interfaces" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/api.html">Program Interfaces</a>
 121 </div>
 122 <div class="sub">
 123     <a title="Program Interface: MagickWand" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick-wand.html">MagickWand</a>
 124 </div>
 125 <div class="sub">
 126     <a title="Program Interface: MagickCore" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick-core.html">MagickCore</a>
 127 </div>
 128 <div class="sub">
 129     <a title="Program Interface: PerlMagick" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/perl-magick.html">PerlMagick</a>
 130 </div>
 131 <div class="sub">
 132     <a title="Program Interface: Magick++" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/magick++.html">Magick++</a>
 133 </div>
 134 <div class="sep"></div>\r
 135 <div  class="menu">
 136    <a title="Install from Source" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/install-source.html">Install from Source</a>
 137 </div>
 138 <div class="sub">
 139     <a title="Install from Source: Unix" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/install-source.html#unix">Unix</a>
 140 </div>
 141 <div class="sub">
 142     <a title="Install from Source: Windows" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/install-source.html#windows">Windows</a>
 143  </div>
 144 <div class="menu">
 145   <a title="Resources" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/resources.html">Resources</a>
 146 </div>
 147 <div class="menu">
 148   <a title="Architecture" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/architecture.html">Architecture</a>
 149 </div>
 150 <div class="menu">
 151   <a title="Download" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/download.html">Download</a>
 152 </div>
 153 <div class="sep"></div>\r
 154 <div class="menu">
 155   <a title="Search" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/search.html">Search</a>
 156 </div>
 157 <div class="sep"></div>\r
 158 <div class="menu">
 159   <a title="Site Map" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/sitemap.html">Site Map</a>
 160 </div>
 161 <div  class="sub">
 162   <a title="Site Map: Links" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/links.html">Links</a>
 163 </div>
 164 <div class="sep"></div>\r
 165 <div class="menu">
 166   <a rel="follow" title="Sponsors" href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../www/sponsors.html">Sponsors:</a>
 167
 168   <a href="http://www.networkredux.com"> <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/networkredux.png" width="140" height="31" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a>
 169   <a href="http://www.dinodirect.com/ipads-tablets/"> <img src="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../images/dino-direct.jpg" width="140" height="90" alt="[sponsor]" style="margin-top: 4px; margin-left: 4px; border: 0px; float: left;" /></a><!-- 201208010120 mickey@163... -->
 170 <div class="sponsbox">
 171 <div class="sponsor">
 172   <a rel="follow" title="Sponsor: The Fastest &amp; Easiest Way to Find Images" href="http://www.graphicsfactory.com">The Fastest &amp; Easiest Way to Find Images</a><!-- 201210010270 graphicsfac... -->
 173 </div>
 174 <div class="sponsor">
 175   <a rel="follow" title="Sponsor: VPS" href="http://www.interdominios.com/vps">VPS</a><!-- 201209010090 barsh@inter... -->
 176 </div>
 177 <div class="sponsor">
 178   <a rel="follow" title="Werbebanner Werbeplane" href="http://www.allesbanner.de">Werbebanner Werbeplane</a><!-- 201212010450 info@druck... -->
 179 </div>
 180 <div class="sponsor">
 181   <a rel="follow" title="Entertainment News &amp; Photos" href="http://www.zimbio.com">Entertainment News &amp; Photos</a><!-- 201211010540 bd@zimb... -->
 182 </div>
 183 <div class="sponsor">
 184   <a rel="follow" title="Sponsor: LED24" href="http://led24.de/">LED24</a><!-- 201207010270 info@led24... -->
 185 </div>
 186 <div class="sponsor">
 187   <a rel="follow" title="Sponsor: Best Website Hosting" href="http://www.top-cheap-web-hosting.com">Best Website Hosting</a><!-- 201304010090 eunge.liu-->
 188 </div>
 189 <div class="sponsor">
 190   <a rel="follow" title="Android Tablet" href="http://www.dinodirect.com/ipads-tablets/">Android Tablet</a><!-- 201208010120 mickey@163... -->
 191 </div>
 192 <div class="sponsor">
 193   <a rel="follow" title="Sponsor: Web Site Hosting" href="http://webhostinggeeks.com">Web Site Hosting</a><!-- 201302010900 funds@enmob... -->
 194 </div>
 195 <div class="sponsor">
 196    <a rel="follow" title="Sponsor: Premium Quality Stock Photos" href="http://www.f1online.pro/en/">Premium Quality Stock Photos</a><!-- 2012080100540 ... -->
 197 </div>
 198 <div class="sponsor">
 199    <a rel="follow" title="Sponsor: Druckerei" href="http://print24.com/de/">Druckerei</a><!-- 2012070100250 ... -->
 200 </div>
 201 <div class="sponsor">
 202   <a rel="follow" title="Sponsor: Managed Server" href="http://www.robhost.de">Managed Server</a><!-- 201210010720 klikics... -->
 203 </div>
 204 <div class="sponsor">
 205   <a rel="follow" title="Sponsor: Druckerei" href="http://www.allesdruck.de">Druckerei</a><!-- 201303011500 r.leo -->
 206 </div>
 207 <div class="sponsor">
 208    <a rel="follow" title="Sponsor: Names List" href="http://www.listofnames.info">Names List</a><!-- 2012110100180 grimshrat@busyb-->
 209 </div>
 210 <div class="sponsor">
 211    <a rel="follow" title="Sponsor: Fototapete - Tapetendruck" href="http://www.druck-expert.com/Fototapete-Tapetendruck,category,8830.html">Fototapete - Tapetendruck</a><!-- 2012100100155 info@druck-->
 212 </div>
 213 </div>
 214 </div>
 215 </div>\r
 216 \r
 217 <div class="eastbar">\r
 218   <div class="g-plusone" id="gplusone"></div>\r
 219   <script type="text/javascript">\r
 220     window.___gcfg = {\r
 221       lang: 'en-US'\r
 222     };\r
 223 \r
 224     (function() {\r
 225       var po = document.createElement('script');\r
 226       po.type = 'text/javascript'; po.async = true;\r
 227       po.src = 'https://apis.google.com/js/plusone.js';\r
 228       var script = document.getElementsByTagName('script')[0];\r
 229       script.parentNode.insertBefore(po, script);\r
 230     })();\r
 231     var gplusone = document.getElementById("gplusone");\r
 232     gplusone.setAttribute("data-size","medium");\r
 233     gplusone.setAttribute("data-count","false");\r
 234   </script>\r
 235 </div>\r
 236 \r
 237 <div class="main">\r
 238 \r
 239 <h1>Module registry Methods</h1>
 240 <p class="navigation-index">[<a href="registry.html#DefineImageRegistry">DefineImageRegistry</a> &bull; <a href="registry.html#DeleteImageRegistry">DeleteImageRegistry</a> &bull; <a href="registry.html#GetImageRegistry">GetImageRegistry</a> &bull; <a href="registry.html#GetNextImageRegistry">GetNextImageRegistry</a> &bull; <a href="registry.html#RegistryComponentTerminus">RegistryComponentTerminus</a> &bull; <a href="registry.html#RemoveImageRegistry">RemoveImageRegistry</a> &bull; <a href="registry.html#ResetImageRegistryIterator">ResetImageRegistryIterator</a> &bull; <a href="registry.html#SetImageRegistry">SetImageRegistry</a>]</p>
 241
 242 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="DefineImageRegistry">DefineImageRegistry</a></h2>
 243 <div class="doc-section">
 244
 245 <p>DefineImageRegistry() associates a key/value pair with the image registry.</p>
 246
 247 <p>The format of the DefineImageRegistry method is:</p>
 248
 249 <pre class="code">
 250   MagickBooleanType DefineImageRegistry(const RegistryType type,
 251     const char *option,ExceptionInfo *exception)
 252 </pre>
 253
 254 <p>A description of each parameter follows:</p>
 255
 256 <h5>type</h5>
 257 <p>the type.</p>
 258
 259 <h5>option</h5>
 260 <p>the option.</p>
 261
 262 <h5>exception</h5>
 263 <p>the exception.</p>
 264
 265  </div>
 266 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="DeleteImageRegistry">DeleteImageRegistry</a></h2>
 267 <div class="doc-section">
 268
 269 <p>DeleteImageRegistry() deletes a key from the image registry.</p>
 270
 271 <p>The format of the DeleteImageRegistry method is:</p>
 272
 273 <pre class="code">
 274   MagickBooleanType DeleteImageRegistry(const char *key)
 275 </pre>
 276
 277 <p>A description of each parameter follows:</p>
 278
 279 <h5>key</h5>
 280 <p>the registry.</p>
 281
 282  </div>
 283 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="GetImageRegistry">GetImageRegistry</a></h2>
 284 <div class="doc-section">
 285
 286 <p>GetImageRegistry() returns a value associated with an image registry key.</p>
 287
 288 <p>The format of the GetImageRegistry method is:</p>
 289
 290 <pre class="code">
 291   void *GetImageRegistry(const RegistryType type,const char *key,
 292     ExceptionInfo *exception)
 293 </pre>
 294
 295 <p>A description of each parameter follows:</p>
 296
 297 <h5>type</h5>
 298 <p>the type.</p>
 299
 300 <h5>key</h5>
 301 <p>the key.</p>
 302
 303 <h5>exception</h5>
 304 <p>the exception.</p>
 305
 306  </div>
 307 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="GetNextImageRegistry">GetNextImageRegistry</a></h2>
 308 <div class="doc-section">
 309
 310 <p>GetNextImageRegistry() gets the next image registry value.</p>
 311
 312 <p>The format of the GetNextImageRegistry method is:</p>
 313
 314 <pre class="code">
 315   char *GetNextImageRegistry(void)
 316 </pre>
 317
 318  </div>
 319 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="RegistryComponentTerminus">RegistryComponentTerminus</a></h2>
 320 <div class="doc-section">
 321
 322 <p>RegistryComponentTerminus() destroys the registry component.</p>
 323
 324 <p>The format of the DestroyDefines method is:</p>
 325
 326 <pre class="code">
 327   void RegistryComponentTerminus(void)
 328 </pre>
 329
 330  </div>
 331 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="RemoveImageRegistry">RemoveImageRegistry</a></h2>
 332 <div class="doc-section">
 333
 334 <p>RemoveImageRegistry() removes a key from the image registry and returns its value.</p>
 335
 336 <p>The format of the RemoveImageRegistry method is:</p>
 337
 338 <pre class="code">
 339   void *RemoveImageRegistry(const char *key)
 340 </pre>
 341
 342 <p>A description of each parameter follows:</p>
 343
 344 <h5>key</h5>
 345 <p>the registry.</p>
 346
 347  </div>
 348 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="ResetImageRegistryIterator">ResetImageRegistryIterator</a></h2>
 349 <div class="doc-section">
 350
 351 <p>ResetImageRegistryIterator() resets the registry iterator.  Use it in conjunction with GetNextImageRegistry() to iterate over all the values in the image registry.</p>
 352
 353 <p>The format of the ResetImageRegistryIterator method is:</p>
 354
 355 <pre class="code">
 356   ResetImageRegistryIterator(void)
 357 </pre>
 358
 359  </div>
 360 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="SetImageRegistry">SetImageRegistry</a></h2>
 361 <div class="doc-section">
 362
 363 <p>SetImageRegistry() associates a value with an image registry key.</p>
 364
 365 <p>The format of the SetImageRegistry method is:</p>
 366
 367 <pre class="code">
 368   MagickBooleanType SetImageRegistry(const RegistryType type,
 369     const char *key,const void *value,ExceptionInfo *exception)
 370 </pre>
 371
 372 <p>A description of each parameter follows:</p>
 373
 374 <h5>type</h5>
 375 <p>the type.</p>
 376
 377 <h5>key</h5>
 378 <p>the key.</p>
 379
 380 <h5>value</h5>
 381 <p>the value.</p>
 382
 383 <h5>exception</h5>
 384 <p>the exception.</p>
 385
 386  </div>
 387 \r
 388 </div>\r
 389 \r
 390 <div id="linkbar">\r
 391     <span id="linkbar-west">&nbsp;</span>\r
 392     <span id="linkbar-center">\r
 393       <a href="../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../../discourse-server">Discourse Server</a> &bull;\r
 394       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a>\r
 395     </span>\r
 396     <span id="linkbar-east">&nbsp;</span>\r
 397   </div>\r
 398   <div class="footer">\r
 399     <span id="footer-west">&copy; 1999-2012 ImageMagick Studio LLC</span>\r
 400     <span id="footer-east"> <a href="http://www.imagemagick.org/script/contact.php">Contact the Wizards</a></span>\r
 401   </div>\r
 402   <div style="clear: both; margin: 0; width: 100%; "></div>\r
 403   <script type="text/javascript">\r
 404     var _gaq = _gaq || [];\r
 405     _gaq.push(['_setAccount', 'UA-17690367-1']);\r
 406     _gaq.push(['_trackPageview']);\r
 407 \r
 408     (function() {\r
 409       var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;\r
 410       ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';\r
 411       var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);\r
 412     })();\r
 413   </script>\r
 414 </body>\r
 415 </html>\r