www/api/registry.html - platform/external/ImageMagick - Gitiles

 <!DOCTYPE html>
 <html lang="en">
 <head>
   <meta charset="utf-8">
   <meta http-equiv="X-UA-Compatible" content="IE=edge">
   <meta name="viewport" content="width=device-width, initial-scale=1">
   <title>ImageMagick: MagickCore, C API for ImageMagick: The Image Registry</title>
   <meta http-equiv="content-language" content="en-US">
   <meta http-equiv="content-type" content="text/html; charset=utf-8">
   <meta http-equiv="reply-to" content="magick-users@imagemagick.org">
   <meta name="application-name" content="ImageMagick">
   <meta name="description" content="ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.">
   <meta name="application-url" content="http://www.imagemagick.org">
   <meta name="generator" content="PHP">
   <meta name="keywords" content="magickcore, c, api, for, imagemagick:, the, image, registry, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert">
   <meta name="rating" content="GENERAL">
   <meta name="robots" content="INDEX, FOLLOW">
   <meta name="generator" content="ImageMagick Studio LLC">
   <meta name="author" content="ImageMagick Studio LLC">
   <meta name="revisit-after" content="2 DAYS">
   <meta name="resource-type" content="document">
   <meta name="copyright" content="Copyright (c) 1999-2015 ImageMagick Studio LLC">
   <meta name="distribution" content="Global">
   <meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1">
   <link rel="icon" href="../images/wand.png">
   <link rel="shortcut icon" href="../images/wand.ico" type="images/x-icon">
   <link rel="stylesheet" href="../css/bootstrap.min.css">
   <link rel="stylesheet" href="../css/magick.css">
 </head>

 <body>
 <div class="main">
 <div class="magick-masthead">
   <div class="container">
     <script type="text/javascript">
     <!--
       google_ad_client = "pub-3129977114552745";
       google_ad_slot = "5439289906";
       google_ad_width = 728;
       google_ad_height = 90;
     //-->
     </script>
     <center><script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
     </script></center>
     <nav class="magick-nav">
       <a class="magick-nav-item " href="../index.html">Home</a>
       <a class="magick-nav-item " href="../binary-releases.html">Downloads</a>
       <a class="magick-nav-item " href="../command-line-tools.html">Tools</a>
       <a class="magick-nav-item " href="../command-line-options.html">Options</a>
       <a class="magick-nav-item " href="api.html">Development</a>
       <a class="magick-nav-item" href="http://www.imagemagick.org/discourse-server/">Community</a>
       <a class="magick-nav-item pull-right " href="http://www.imagemagick.org/script/search.php">Search</a>
     </nav>
   </div>
 </div>
 <div class="container">
 <div class="magick-header">
 <p class="text-center"><a href="registry.html#DefineImageRegistry">DefineImageRegistry</a> • <a href="registry.html#DeleteImageRegistry">DeleteImageRegistry</a> • <a href="registry.html#GetImageRegistry">GetImageRegistry</a> • <a href="registry.html#GetNextImageRegistry">GetNextImageRegistry</a> • <a href="registry.html#RegistryComponentTerminus">RegistryComponentTerminus</a> • <a href="registry.html#RemoveImageRegistry">RemoveImageRegistry</a> • <a href="registry.html#ResetImageRegistryIterator">ResetImageRegistryIterator</a> • <a href="registry.html#SetImageRegistry">SetImageRegistry</a></p>

 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="DefineImageRegistry">DefineImageRegistry</a></h2>

 <p>DefineImageRegistry() associates a key/value pair with the image registry.</p>

 <p>The format of the DefineImageRegistry method is:</p>

 <pre class="text">
 MagickBooleanType DefineImageRegistry(const RegistryType type,
   const char *option,ExceptionInfo *exception)
 </pre>

 <p>A description of each parameter follows:</p>

 <dd>
 </dd>

 <dd> </dd>
 <dl class="dl-horizontal">
 <dt>type</dt>
 <dd>the type. </dd>

 <dd> </dd>
 <dt>option</dt>
 <dd>the option. </dd>

 <dd> </dd>
 <dt>exception</dt>
 <dd>the exception. </dd>

 <dd>  </dd>
 </dl>
 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="DeleteImageRegistry">DeleteImageRegistry</a></h2>

 <p>DeleteImageRegistry() deletes a key from the image registry.</p>

 <p>The format of the DeleteImageRegistry method is:</p>

 <pre class="text">
 MagickBooleanType DeleteImageRegistry(const char *key)
 </pre>

 <p>A description of each parameter follows:</p>

 <dd>
 </dd>

 <dd> </dd>
 <dl class="dl-horizontal">
 <dt>key</dt>
 <dd>the registry. </dd>

 <dd>  </dd>
 </dl>
 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="GetImageRegistry">GetImageRegistry</a></h2>

 <p>GetImageRegistry() returns a value associated with an image registry key.</p>

 <p>The format of the GetImageRegistry method is:</p>

 <pre class="text">
 void *GetImageRegistry(const RegistryType type,const char *key,
   ExceptionInfo *exception)
 </pre>

 <p>A description of each parameter follows:</p>

 <dd>
 </dd>

 <dd> </dd>
 <dl class="dl-horizontal">
 <dt>type</dt>
 <dd>the type. </dd>

 <dd> </dd>
 <dt>key</dt>
 <dd>the key. </dd>

 <dd> </dd>
 <dt>exception</dt>
 <dd>the exception. </dd>

 <dd>  </dd>
 </dl>
 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="GetNextImageRegistry">GetNextImageRegistry</a></h2>

 <p>GetNextImageRegistry() gets the next image registry value.</p>

 <p>The format of the GetNextImageRegistry method is:</p>

 <pre class="text">
 char *GetNextImageRegistry(void)
 </pre>

 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="RegistryComponentTerminus">RegistryComponentTerminus</a></h2>

 <p>RegistryComponentTerminus() destroys the registry component.</p>

 <p>The format of the DestroyDefines method is:</p>

 <pre class="text">
 void RegistryComponentTerminus(void)
 </pre>

 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="RemoveImageRegistry">RemoveImageRegistry</a></h2>

 <p>RemoveImageRegistry() removes a key from the image registry and returns its value.</p>

 <p>The format of the RemoveImageRegistry method is:</p>

 <pre class="text">
 void *RemoveImageRegistry(const char *key)
 </pre>

 <p>A description of each parameter follows:</p>

 <dd>
 </dd>

 <dd> </dd>
 <dl class="dl-horizontal">
 <dt>key</dt>
 <dd>the registry. </dd>

 <dd>  </dd>
 </dl>
 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="ResetImageRegistryIterator">ResetImageRegistryIterator</a></h2>

 <p>ResetImageRegistryIterator() resets the registry iterator.  Use it in conjunction with GetNextImageRegistry() to iterate over all the values in the image registry.</p>

 <p>The format of the ResetImageRegistryIterator method is:</p>

 <pre class="text">
 ResetImageRegistryIterator(void)
 </pre>

 <h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="SetImageRegistry">SetImageRegistry</a></h2>

 <p>SetImageRegistry() associates a value with an image registry key.</p>

 <p>The format of the SetImageRegistry method is:</p>

 <pre class="text">
 MagickBooleanType SetImageRegistry(const RegistryType type,
   const char *key,const void *value,ExceptionInfo *exception)
 </pre>

 <p>A description of each parameter follows:</p>

 <dd>
 </dd>

 <dd> </dd>
 <dl class="dl-horizontal">
 <dt>type</dt>
 <dd>the type. </dd>

 <dd> </dd>
 <dt>key</dt>
 <dd>the key. </dd>

 <dd> </dd>
 <dt>value</dt>
 <dd>the value. </dd>

 <dd> </dd>
 <dt>exception</dt>
 <dd>the exception. </dd>

 <dd>  </dd>
 </dl>
 </div>
   <footer class="magick-footer">
     <div class="magick-nav-item pull-left">
       <a href="../support.html">Donate</a>
     </div>
     <p><a href="../sitemap.html">Sitemap</a> •
     <a href="../links.html">Related</a> •
     <a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Image Studio</a> •
     <a href="http://jqmagick.imagemagick.org/">JqMagick</a> •
     <a href="http://pgp.mit.edu:11371/pks/lookup?op=get&amp;search=0x89AB63D48277377A">Public Key</a>
 </p>
     <p><a href="registry.html#">Back to top</a> •
     <a href="http://www.imagemagick.org/script/contact.php">Contact Us</a></p>
     <p class="small">©  1999-2015 ImageMagick Studio LLC</p>
   </footer>
 </div><!-- /.container -->

   <script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
   <script src="../js/bootstrap.min.js"></script>
   <script type="text/javascript">
     /* <![CDATA[ */
     (function() {
         var s = document.createElement('offline-script'), t = document.getElementsByTagName('offline-script')[0];
         s.type = 'text/javascript';
         s.async = true;
         s.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto';
         t.parentNode.insertBefore(s, t);
     })();
     /* ]]> */
   </script>
 </div>
 </body>
 </html>
	<!DOCTYPE html>
	<html lang="en">
	<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<title>ImageMagick: MagickCore, C API for ImageMagick: The Image Registry</title>
	<meta http-equiv="content-language" content="en-US">
	<meta http-equiv="content-type" content="text/html; charset=utf-8">
	<meta http-equiv="reply-to" content="magick-users@imagemagick.org">
	<meta name="application-name" content="ImageMagick">
	<meta name="description" content="ImageMagick® is a software suite to create, edit, compose, or convert bitmap images. It can read and write images in a variety of formats (over 200) including PNG, JPEG, JPEG-2000, GIF, WebP, Postscript, PDF, and SVG. Use ImageMagick to resize, flip, mirror, rotate, distort, shear and transform images, adjust image colors, apply various special effects, or draw text, lines, polygons, ellipses and Bézier curves.">
	<meta name="application-url" content="http://www.imagemagick.org">
	<meta name="generator" content="PHP">
	<meta name="keywords" content="magickcore, c, api, for, imagemagick:, the, image, registry, ImageMagick, PerlMagick, image processing, image, photo, software, Magick++, OpenMP, convert">
	<meta name="rating" content="GENERAL">
	<meta name="robots" content="INDEX, FOLLOW">
	<meta name="generator" content="ImageMagick Studio LLC">
	<meta name="author" content="ImageMagick Studio LLC">
	<meta name="revisit-after" content="2 DAYS">
	<meta name="resource-type" content="document">
	<meta name="copyright" content="Copyright (c) 1999-2015 ImageMagick Studio LLC">
	<meta name="distribution" content="Global">
	<meta name="magick-serial" content="P131-S030410-R485315270133-P82224-A6668-G1245-1">
	<link rel="icon" href="../images/wand.png">
	<link rel="shortcut icon" href="../images/wand.ico" type="images/x-icon">
	<link rel="stylesheet" href="../css/bootstrap.min.css">
	<link rel="stylesheet" href="../css/magick.css">
	</head>

	<body>
	<div class="main">
	<div class="magick-masthead">
	<div class="container">
	<script type="text/javascript">
	<!--
	google_ad_client = "pub-3129977114552745";
	google_ad_slot = "5439289906";
	google_ad_width = 728;
	google_ad_height = 90;
	//-->
	</script>
	<center><script type="text/javascript" src="http://pagead2.googlesyndication.com/pagead/show_ads.js">
	</script></center>
	<nav class="magick-nav">
	<a class="magick-nav-item " href="../index.html">Home</a>
	<a class="magick-nav-item " href="../binary-releases.html">Downloads</a>
	<a class="magick-nav-item " href="../command-line-tools.html">Tools</a>
	<a class="magick-nav-item " href="../command-line-options.html">Options</a>
	<a class="magick-nav-item " href="api.html">Development</a>
	<a class="magick-nav-item" href="http://www.imagemagick.org/discourse-server/">Community</a>
	<a class="magick-nav-item pull-right " href="http://www.imagemagick.org/script/search.php">Search</a>
	</nav>
	</div>
	</div>
	<div class="container">
	<div class="magick-header">
	<p class="text-center"><a href="registry.html#DefineImageRegistry">DefineImageRegistry</a> • <a href="registry.html#DeleteImageRegistry">DeleteImageRegistry</a> • <a href="registry.html#GetImageRegistry">GetImageRegistry</a> • <a href="registry.html#GetNextImageRegistry">GetNextImageRegistry</a> • <a href="registry.html#RegistryComponentTerminus">RegistryComponentTerminus</a> • <a href="registry.html#RemoveImageRegistry">RemoveImageRegistry</a> • <a href="registry.html#ResetImageRegistryIterator">ResetImageRegistryIterator</a> • <a href="registry.html#SetImageRegistry">SetImageRegistry</a></p>

	<h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="DefineImageRegistry">DefineImageRegistry</a></h2>

	<p>DefineImageRegistry() associates a key/value pair with the image registry.</p>

	<p>The format of the DefineImageRegistry method is:</p>

	<pre class="text">
	MagickBooleanType DefineImageRegistry(const RegistryType type,
	const char option,ExceptionInfo exception)
	</pre>

	<p>A description of each parameter follows:</p>

	<dd>
	</dd>

	<dd> </dd>
	<dl class="dl-horizontal">
	<dt>type</dt>
	<dd>the type. </dd>

	<dd> </dd>
	<dt>option</dt>
	<dd>the option. </dd>

	<dd> </dd>
	<dt>exception</dt>
	<dd>the exception. </dd>

	<dd> </dd>
	</dl>
	<h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="DeleteImageRegistry">DeleteImageRegistry</a></h2>

	<p>DeleteImageRegistry() deletes a key from the image registry.</p>

	<p>The format of the DeleteImageRegistry method is:</p>

	<pre class="text">
	MagickBooleanType DeleteImageRegistry(const char *key)
	</pre>

	<p>A description of each parameter follows:</p>

	<dd>
	</dd>

	<dd> </dd>
	<dl class="dl-horizontal">
	<dt>key</dt>
	<dd>the registry. </dd>

	<dd> </dd>
	</dl>
	<h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="GetImageRegistry">GetImageRegistry</a></h2>

	<p>GetImageRegistry() returns a value associated with an image registry key.</p>

	<p>The format of the GetImageRegistry method is:</p>

	<pre class="text">
	void GetImageRegistry(const RegistryType type,const char key,
	ExceptionInfo *exception)
	</pre>

	<p>A description of each parameter follows:</p>

	<dd>
	</dd>

	<dd> </dd>
	<dl class="dl-horizontal">
	<dt>type</dt>
	<dd>the type. </dd>

	<dd> </dd>
	<dt>key</dt>
	<dd>the key. </dd>

	<dd> </dd>
	<dt>exception</dt>
	<dd>the exception. </dd>

	<dd> </dd>
	</dl>
	<h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="GetNextImageRegistry">GetNextImageRegistry</a></h2>

	<p>GetNextImageRegistry() gets the next image registry value.</p>

	<p>The format of the GetNextImageRegistry method is:</p>

	<pre class="text">
	char *GetNextImageRegistry(void)
	</pre>

	<h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="RegistryComponentTerminus">RegistryComponentTerminus</a></h2>

	<p>RegistryComponentTerminus() destroys the registry component.</p>

	<p>The format of the DestroyDefines method is:</p>

	<pre class="text">
	void RegistryComponentTerminus(void)
	</pre>

	<h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="RemoveImageRegistry">RemoveImageRegistry</a></h2>

	<p>RemoveImageRegistry() removes a key from the image registry and returns its value.</p>

	<p>The format of the RemoveImageRegistry method is:</p>

	<pre class="text">
	void RemoveImageRegistry(const char key)
	</pre>

	<p>A description of each parameter follows:</p>

	<dd>
	</dd>

	<dd> </dd>
	<dl class="dl-horizontal">
	<dt>key</dt>
	<dd>the registry. </dd>

	<dd> </dd>
	</dl>
	<h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="ResetImageRegistryIterator">ResetImageRegistryIterator</a></h2>

	<p>ResetImageRegistryIterator() resets the registry iterator. Use it in conjunction with GetNextImageRegistry() to iterate over all the values in the image registry.</p>

	<p>The format of the ResetImageRegistryIterator method is:</p>

	<pre class="text">
	ResetImageRegistryIterator(void)
	</pre>

	<h2><a href="http://www.imagemagick.org/api/MagickCore/registry_8c.html" id="SetImageRegistry">SetImageRegistry</a></h2>

	<p>SetImageRegistry() associates a value with an image registry key.</p>

	<p>The format of the SetImageRegistry method is:</p>

	<pre class="text">
	MagickBooleanType SetImageRegistry(const RegistryType type,
	const char key,const void value,ExceptionInfo *exception)
	</pre>

	<p>A description of each parameter follows:</p>

	<dd>
	</dd>

	<dd> </dd>
	<dl class="dl-horizontal">
	<dt>type</dt>
	<dd>the type. </dd>

	<dd> </dd>
	<dt>key</dt>
	<dd>the key. </dd>

	<dd> </dd>
	<dt>value</dt>
	<dd>the value. </dd>

	<dd> </dd>
	<dt>exception</dt>
	<dd>the exception. </dd>

	<dd> </dd>
	</dl>
	</div>
	<footer class="magick-footer">
	<div class="magick-nav-item pull-left">
	<a href="../support.html">Donate</a>
	</div>
	<p><a href="../sitemap.html">Sitemap</a> •
	<a href="../links.html">Related</a> •
	<a href="http://www.imagemagick.org/MagickStudio/scripts/MagickStudio.cgi">Image Studio</a> •
	<a href="http://jqmagick.imagemagick.org/">JqMagick</a> •
	<a href="http://pgp.mit.edu:11371/pks/lookup?op=get&search=0x89AB63D48277377A">Public Key</a>
	</p>
	<p><a href="registry.html#">Back to top</a> •
	<a href="http://www.imagemagick.org/script/contact.php">Contact Us</a></p>
	<p class="small">© 1999-2015 ImageMagick Studio LLC</p>
	</footer>
	</div><!-- /.container -->

	<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.2/jquery.min.js"></script>
	<script src="../js/bootstrap.min.js"></script>
	<script type="text/javascript">
	/* <![CDATA[ */
	(function() {
	var s = document.createElement('offline-script'), t = document.getElementsByTagName('offline-script')[0];
	s.type = 'text/javascript';
	s.async = true;
	s.src = 'http://api.flattr.com/js/0.6/load.js?mode=auto';
	t.parentNode.insertBefore(s, t);
	})();
	/* ]]> */
	</script>
	</div>
	</body>
	</html>