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

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
   2   "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
   3 <html version="-//W3C//DTD XHTML 1.1//EN"
   4       xmlns="http://www.w3.org/1999/xhtml" xml:lang="en"
   5       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   6       xsi:schemaLocation="http://www.w3.org/1999/xhtml
   7                           http://www.w3.org/MarkUp/SCHEMA/xhtml11.xsd">
   8 <head>
   9   <meta http-equiv="content-type" content="text/html; charset=UTF-8"/>
  10   <meta name="google-site-verification" content="_bMOCDpkx9ZAzBwb2kF3PRHbfUUdFj2uO8Jd1AXArz4"/>
  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 or 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="../../index.html" />
  31   <link rel="meta" type="application/rdf+xml" title="ICI" href="http://imagemagick.org/ici.rdf"/>
  32
  33   <!-- Add jQuery library -->
  34   <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7/jquery.min.js"></script>
  35
  36   <!-- Add mousewheel plugin (this is optional) -->
  37   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/lib/jquery.mousewheel-3.0.6.pack.js"></script>
  38
  39   <!-- Add fancyBox -->
  40   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/jquery.fancybox.css?v=2.0.6" type="text/css" media="screen" />
  41   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/jquery.fancybox.pack.js?v=2.0.6"></script>
  42
  43   <!-- Optionally add helpers - button, thumbnail and/or media -->
  44   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.css?v=1.0.2" type="text/css" media="screen" />
  45   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-buttons.js?v=1.0.2"></script>
  46   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-media.js?v=1.0.0"></script>
  47
  48   <link rel="stylesheet" href="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.css?v=2.0.6" type="text/css" media="screen" />
  49   <script type="text/javascript" src="http://www.imagemagick.org/fancybox/source/helpers/jquery.fancybox-thumbs.js?v=2.0.6"></script>
  50
  51   <script type="text/javascript">
  52         $(document).ready(function() {
  53                 $(".fancybox").fancybox();
  54         });
  55   </script>
  56
  57   <!-- ImageMagick style -->
  58   <style type="text/css" media="all">
  59     @import url("../../www/magick.css");
  60   </style>
  61 </head>
  62
  63 <body id="www-imagemagick-org">
  64
  65 <script>
  66   (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
  67   (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
  68   m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
  69   })(window,document,'offline-script','//www.google-analytics.com/analytics.js','ga');
  70
  71   ga('create', 'UA-40133312-1', 'imagemagick.org');
  72   ga('send', 'pageview');
  73 </script>
  74
  75 <div class="titlebar">
  76 <div style="margin: 17px auto; float: left;">
  77   <script type="text/javascript">
  78   <!--
  79     google_ad_client = "pub-3129977114552745";
  80     google_ad_slot = "5439289906";
  81     google_ad_width = 728;
  82     google_ad_height = 90;
  83   //-->
  84   </script>
  85   <script type="text/javascript"
  86     src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
  87   </script>
  88 </div>
  89 <a href="../../discourse-server">
  90   <img src="../../images/logo.jpg"
  91   alt="ImageMagick Logo"
  92   style="width: 123px; height: 118px; border: 0px; float: right;" /></a>
  93 <a href="../../index.html">
  94   <img src="../../images/sprite.jpg"
  95   alt="ImageMagick Sprite"
  96   style="width: 114px; height: 118px; border: 0px; float: right;" /></a>
  97 </div>
  98
  99 <div class="westbar">
 100
 101 <div class="menu">
 102   <a title="About ImageMagick" href="../../index.html">About ImageMagick</a>
 103 </div>
 104 <div class="menu">
 105   <a title="Binary Releases" href="../../www/binary-releases.html">Binary Releases</a>
 106 </div>
 107 <div class="sub">
 108     <a title="Binary Release: Unix" href="../../www/binary-releases.html#unix">Unix</a>
 109 </div>
 110 <div class="sub">
 111     <a title="Binary Release: MacOS X" href="../../www/binary-releases.html#macosx">Mac OS X</a>
 112 </div>
 113 <div class="sub">
 114     <a title="Binary Release: iOS" href="../../www/binary-releases.html#iOS">iOS</a>
 115 </div>
 116 <div class="sub">
 117     <a title="Binary Release: Windows" href="../../www/binary-releases.html#windows">Windows</a>
 118 </div>
 119 <div class="sep"></div>
 120 <div class="menu">
 121   <a title="Command-line Tools" href="../../www/command-line-tools.html">Command-line Tools</a>
 122 </div>
 123 <div class="sub">
 124     <a title="Command-line Tools: Processing" href="../../www/command-line-processing.html">Processing</a>
 125 </div>
 126 <div class="sub">
 127     <a title="Command-line Tools: Options" href="../../www/command-line-options.html">Options</a>
 128 </div>
 129 <div class="sub">
 130     <a title="Command-line Tools: Usage" href="http://www.imagemagick.org/Usage/">Usage</a>
 131 </div>
 132 <div class="menu">
 133   <a title="Program Interfaces" href="../../www/api.html">Program Interfaces</a>
 134 </div>
 135 <div class="sub">
 136     <a title="Program Interface: MagickWand" href="../../www/magick-wand.html">MagickWand</a>
 137 </div>
 138 <div class="sub">
 139     <a title="Program Interface: MagickCore" href="../../www/magick-core.html">MagickCore</a>
 140 </div>
 141 <div class="sub">
 142     <a title="Program Interface: PerlMagick" href="../../www/perl-magick.html">PerlMagick</a>
 143 </div>
 144 <div class="sub">
 145     <a title="Program Interface: Magick++" href="../../www/magick++.html">Magick++</a>
 146 </div>
 147 <div class="sep"></div>
 148 <div  class="menu">
 149    <a title="Install from Source" href="../../www/install-source.html">Install from Source</a>
 150 </div>
 151 <div class="sub">
 152     <a title="Install from Source: Unix" href="../../www/install-source.html#unix">Unix</a>
 153 </div>
 154 <div class="sub">
 155     <a title="Install from Source: Windows" href="../../www/install-source.html#windows">Windows</a>
 156  </div>
 157 <div class="menu">
 158   <a title="Resources" href="../../www/resources.html">Resources</a>
 159 </div>
 160 <div class="menu">
 161   <a title="Architecture" href="../../www/architecture.html">Architecture</a>
 162 </div>
 163 <div class="menu">
 164   <a title="Download" href="../../www/download.html">Download</a>
 165 </div>
 166 <div class="sep"></div>
 167 <div class="menu">
 168   <a title="Search" href="http://www.imagemagick.org/script/search.php">Search</a>
 169 </div>
 170 <div class="sep"></div>
 171 <div class="menu">
 172   <a title="Site Map" href="../../www/sitemap.html">Site Map</a>
 173 </div>
 174 <div  class="sub">
 175   <a title="Site Map: Links" href="../../www/links.html">Links</a>
 176 </div>
 177 <div class="sep"></div>
 178 <div class="menu">
 179   <a title="Support ImageMagick Development" href="../../www/support.html">Support ImageMagick Development</a>
 180 </div>
 181 </div>
 182
 183 <div class="eastbar">
 184   <script type="text/javascript">
 185     /* <![CDATA[ */
 186     (function() {
 187         var po = document.createElement('offline-script'), t = document.getElementsByTagName('offline-script')[0];
 188         po.type = 'text/javascript';
 189         po.async = true;
 190         po.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto';
 191         var script = document.getElementsByTagName('offline-script')[0];
 192         script.parentNode.insertBefore(po, script);
 193     })();
 194     /* ]]> */
 195   </script>
 196   <div> <a class="FlattrButton" style="display:none;" rev="flattr;button:compact;" href="../../index.html"></a></div>
 197   <noscript>
 198     <a href="http://flattr.com/thing/947300/Convert-Edit-And-Compose-Images" target="_blank">
 199     <img src="http://api.flattr.com/button/flattr-badge-large.png" alt="Flattr this" title="Flattr this" width="93" height="20" border="0" /></a>
 200   </noscript>
 201     <div class="g-plusone" id="gplusone"></div>
 202     <script type="text/javascript">
 203       /* <![CDATA[ */
 204       window.___gcfg = {
 205         lang: 'en-US'
 206       };
 207
 208       (function() {
 209         var po = document.createElement('offline-script');
 210         po.type = 'text/javascript';
 211         po.async = true;
 212         po.src = 'https://apis.google.com/js/plusone.js';
 213         var script = document.getElementsByTagName('offline-script')[0];
 214         script.parentNode.insertBefore(po, script);
 215       })();
 216       var gplusone = document.getElementById("gplusone");
 217       gplusone.setAttribute("data-size","medium");
 218       gplusone.setAttribute("data-count","true");
 219       /* ]]> */
 220     </script>
 221 </div>
 222
 223 <div class="main">
 224
 225 <h1>Module registry Methods</h1>
 226 <p class="navigation-index">[<a href="registry.html#DefineImageRegistry">DefineImageRegistry</a> &#8226; <a href="registry.html#DeleteImageRegistry">DeleteImageRegistry</a> &#8226; <a href="registry.html#GetImageRegistry">GetImageRegistry</a> &#8226; <a href="registry.html#GetNextImageRegistry">GetNextImageRegistry</a> &#8226; <a href="registry.html#RegistryComponentTerminus">RegistryComponentTerminus</a> &#8226; <a href="registry.html#RemoveImageRegistry">RemoveImageRegistry</a> &#8226; <a href="registry.html#ResetImageRegistryIterator">ResetImageRegistryIterator</a> &#8226; <a href="registry.html#SetImageRegistry">SetImageRegistry</a>]</p>
 227
 228 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="DefineImageRegistry">DefineImageRegistry</a></h2>
 229 <div class="doc-section">
 230
 231 <p>DefineImageRegistry() associates a key/value pair with the image registry.</p>
 232
 233 <p>The format of the DefineImageRegistry method is:</p>
 234
 235 <pre class="code">
 236   MagickBooleanType DefineImageRegistry(const RegistryType type,
 237     const char *option,ExceptionInfo *exception)
 238 </pre>
 239
 240 <p>A description of each parameter follows:</p>
 241
 242 <h5>type</h5>
 243 <p>the type.</p>
 244
 245 <h5>option</h5>
 246 <p>the option.</p>
 247
 248 <h5>exception</h5>
 249 <p>the exception.</p>
 250
 251  </div>
 252 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="DeleteImageRegistry">DeleteImageRegistry</a></h2>
 253 <div class="doc-section">
 254
 255 <p>DeleteImageRegistry() deletes a key from the image registry.</p>
 256
 257 <p>The format of the DeleteImageRegistry method is:</p>
 258
 259 <pre class="code">
 260   MagickBooleanType DeleteImageRegistry(const char *key)
 261 </pre>
 262
 263 <p>A description of each parameter follows:</p>
 264
 265 <h5>key</h5>
 266 <p>the registry.</p>
 267
 268  </div>
 269 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="GetImageRegistry">GetImageRegistry</a></h2>
 270 <div class="doc-section">
 271
 272 <p>GetImageRegistry() returns a value associated with an image registry key.</p>
 273
 274 <p>The format of the GetImageRegistry method is:</p>
 275
 276 <pre class="code">
 277   void *GetImageRegistry(const RegistryType type,const char *key,
 278     ExceptionInfo *exception)
 279 </pre>
 280
 281 <p>A description of each parameter follows:</p>
 282
 283 <h5>type</h5>
 284 <p>the type.</p>
 285
 286 <h5>key</h5>
 287 <p>the key.</p>
 288
 289 <h5>exception</h5>
 290 <p>the exception.</p>
 291
 292  </div>
 293 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="GetNextImageRegistry">GetNextImageRegistry</a></h2>
 294 <div class="doc-section">
 295
 296 <p>GetNextImageRegistry() gets the next image registry value.</p>
 297
 298 <p>The format of the GetNextImageRegistry method is:</p>
 299
 300 <pre class="code">
 301   char *GetNextImageRegistry(void)
 302 </pre>
 303
 304  </div>
 305 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="RegistryComponentTerminus">RegistryComponentTerminus</a></h2>
 306 <div class="doc-section">
 307
 308 <p>RegistryComponentTerminus() destroys the registry component.</p>
 309
 310 <p>The format of the DestroyDefines method is:</p>
 311
 312 <pre class="code">
 313   void RegistryComponentTerminus(void)
 314 </pre>
 315
 316  </div>
 317 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="RemoveImageRegistry">RemoveImageRegistry</a></h2>
 318 <div class="doc-section">
 319
 320 <p>RemoveImageRegistry() removes a key from the image registry and returns its value.</p>
 321
 322 <p>The format of the RemoveImageRegistry method is:</p>
 323
 324 <pre class="code">
 325   void *RemoveImageRegistry(const char *key)
 326 </pre>
 327
 328 <p>A description of each parameter follows:</p>
 329
 330 <h5>key</h5>
 331 <p>the registry.</p>
 332
 333  </div>
 334 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="ResetImageRegistryIterator">ResetImageRegistryIterator</a></h2>
 335 <div class="doc-section">
 336
 337 <p>ResetImageRegistryIterator() resets the registry iterator.  Use it in conjunction with GetNextImageRegistry() to iterate over all the values in the image registry.</p>
 338
 339 <p>The format of the ResetImageRegistryIterator method is:</p>
 340
 341 <pre class="code">
 342   ResetImageRegistryIterator(void)
 343 </pre>
 344
 345  </div>
 346 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="SetImageRegistry">SetImageRegistry</a></h2>
 347 <div class="doc-section">
 348
 349 <p>SetImageRegistry() associates a value with an image registry key.</p>
 350
 351 <p>The format of the SetImageRegistry method is:</p>
 352
 353 <pre class="code">
 354   MagickBooleanType SetImageRegistry(const RegistryType type,
 355     const char *key,const void *value,ExceptionInfo *exception)
 356 </pre>
 357
 358 <p>A description of each parameter follows:</p>
 359
 360 <h5>type</h5>
 361 <p>the type.</p>
 362
 363 <h5>key</h5>
 364 <p>the key.</p>
 365
 366 <h5>value</h5>
 367 <p>the value.</p>
 368
 369 <h5>exception</h5>
 370 <p>the exception.</p>
 371
 372  </div>
 373
 374 </div>
 375
 376 <div id="linkbar">
 377     <span id="linkbar-west"> </span>
 378
 379     <span id="linkbar-center">
 380       <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a> &#8226;
 381       <a href="../../discourse-server">Discourse Server</a> &#8226;
 382       <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Studio</a> &#8226;
 383       <a href="http://jqmagick.imagemagick.org/">JqMagick</a>
 384     </span>
 385     <span id="linkbar-east"> </span>
 386   </div>
 387   <div class="footer">
 388     <span id="footer-west">©  1999-2013 ImageMagick Studio LLC</span>
 389     <span id="footer-east"> <a href="../../www/contact.html">Contact the Wizards</a></span>
 390   </div>
 391   <div style="clear: both; margin: 0; width: 100%; "></div>
 392 </body>
 393 </html>