diff options
Diffstat (limited to 'devel-docs/libgimp/html/libgimp-gimpproceduraldb.html')
| -rw-r--r-- | devel-docs/libgimp/html/libgimp-gimpproceduraldb.html | 611 |
1 files changed, 611 insertions, 0 deletions
diff --git a/devel-docs/libgimp/html/libgimp-gimpproceduraldb.html b/devel-docs/libgimp/html/libgimp-gimpproceduraldb.html new file mode 100644 index 0000000..7750457 --- /dev/null +++ b/devel-docs/libgimp/html/libgimp-gimpproceduraldb.html @@ -0,0 +1,611 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"> +<html> +<head> +<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> +<title>gimpproceduraldb: GIMP Library Reference Manual</title> +<meta name="generator" content="DocBook XSL Stylesheets Vsnapshot"> +<link rel="home" href="index.html" title="GIMP Library Reference Manual"> +<link rel="up" href="libgimp-general.html" title="Functions not Related to Specific Images"> +<link rel="prev" href="libgimp-gimpplugin.html" title="gimpplugin"> +<link rel="next" href="libgimp-gimpprogress.html" title="gimpprogress"> +<meta name="generator" content="GTK-Doc V1.33.1 (XML mode)"> +<link rel="stylesheet" href="style.css" type="text/css"> +</head> +<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"> +<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="5"><tr valign="middle"> +<td width="100%" align="left" class="shortcuts"> +<a href="#" class="shortcut">Top</a><span id="nav_description"> <span class="dim">|</span> + <a href="#libgimp-gimpproceduraldb.description" class="shortcut">Description</a></span> +</td> +<td><a accesskey="h" href="index.html"><img src="home.png" width="16" height="16" border="0" alt="Home"></a></td> +<td><a accesskey="u" href="libgimp-general.html"><img src="up.png" width="16" height="16" border="0" alt="Up"></a></td> +<td><a accesskey="p" href="libgimp-gimpplugin.html"><img src="left.png" width="16" height="16" border="0" alt="Prev"></a></td> +<td><a accesskey="n" href="libgimp-gimpprogress.html"><img src="right.png" width="16" height="16" border="0" alt="Next"></a></td> +</tr></table> +<div class="refentry"> +<a name="libgimp-gimpproceduraldb"></a><div class="titlepage"></div> +<div class="refnamediv"><table width="100%"><tr> +<td valign="top"> +<h2><span class="refentrytitle"><a name="libgimp-gimpproceduraldb.top_of_page"></a>gimpproceduraldb</span></h2> +<p>gimpproceduraldb — Functions for querying and changing procedural database (PDB) entries.</p> +</td> +<td class="gallery_image" valign="top" align="right"></td> +</tr></table></div> +<div class="refsect1"> +<a name="libgimp-gimpproceduraldb.functions"></a><h2>Functions</h2> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="functions_proto_type"> +<col class="functions_proto_name"> +</colgroup> +<tbody> +<tr> +<td class="function_type"> +<span class="returnvalue">gchar</span> * +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpproceduraldb.html#gimp-procedural-db-temp-name" title="gimp_procedural_db_temp_name ()">gimp_procedural_db_temp_name</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpproceduraldb.html#gimp-procedural-db-get-data" title="gimp_procedural_db_get_data ()">gimp_procedural_db_get_data</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpproceduraldb.html#gimp-procedural-db-set-data" title="gimp_procedural_db_set_data ()">gimp_procedural_db_set_data</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpproceduraldb.html#gimp-procedural-db-dump" title="gimp_procedural_db_dump ()">gimp_procedural_db_dump</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpproceduraldb.html#gimp-procedural-db-query" title="gimp_procedural_db_query ()">gimp_procedural_db_query</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpproceduraldb.html#gimp-procedural-db-proc-exists" title="gimp_procedural_db_proc_exists ()">gimp_procedural_db_proc_exists</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpproceduraldb.html#gimp-procedural-db-proc-info" title="gimp_procedural_db_proc_info ()">gimp_procedural_db_proc_info</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpproceduraldb.html#gimp-procedural-db-proc-arg" title="gimp_procedural_db_proc_arg ()">gimp_procedural_db_proc_arg</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gboolean</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpproceduraldb.html#gimp-procedural-db-proc-val" title="gimp_procedural_db_proc_val ()">gimp_procedural_db_proc_val</a> <span class="c_punctuation">()</span> +</td> +</tr> +<tr> +<td class="function_type"> +<span class="returnvalue">gint</span> +</td> +<td class="function_name"> +<a class="link" href="libgimp-gimpproceduraldb.html#gimp-procedural-db-get-data-size" title="gimp_procedural_db_get_data_size ()">gimp_procedural_db_get_data_size</a> <span class="c_punctuation">()</span> +</td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect1"> +<a name="libgimp-gimpproceduraldb.description"></a><h2>Description</h2> +<p>Functions for querying and changing procedural database (PDB) +entries.</p> +</div> +<div class="refsect1"> +<a name="libgimp-gimpproceduraldb.functions_details"></a><h2>Functions</h2> +<div class="refsect2"> +<a name="gimp-procedural-db-temp-name"></a><h3>gimp_procedural_db_temp_name ()</h3> +<pre class="programlisting"><span class="returnvalue">gchar</span> * +gimp_procedural_db_temp_name (<em class="parameter"><code><span class="type">void</span></code></em>);</pre> +<p>Generates a unique temporary PDB name.</p> +<p>This procedure generates a temporary PDB entry name that is +guaranteed to be unique.</p> +<div class="refsect3"> +<a name="gimp-procedural-db-temp-name.returns"></a><h4>Returns</h4> +<p> A unique temporary name for a temporary PDB entry.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-procedural-db-get-data"></a><h3>gimp_procedural_db_get_data ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_procedural_db_get_data (<em class="parameter"><code>const <span class="type">gchar</span> *identifier</code></em>, + <em class="parameter"><code><span class="type">gpointer</span> data</code></em>);</pre> +<p>Returns data associated with the specified identifier.</p> +<p>This procedure returns any data which may have been associated with +the specified identifier. The data is copied into the given memory +location.</p> +<div class="refsect3"> +<a name="gimp-procedural-db-get-data.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>identifier</p></td> +<td class="parameter_description"><p>The identifier associated with data.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>A byte array containing data.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-procedural-db-get-data.returns"></a><h4>Returns</h4> +<p> TRUE on success, FALSE if no data has been associated with +the identifier</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-procedural-db-set-data"></a><h3>gimp_procedural_db_set_data ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_procedural_db_set_data (<em class="parameter"><code>const <span class="type">gchar</span> *identifier</code></em>, + <em class="parameter"><code><span class="type">gconstpointer</span> data</code></em>, + <em class="parameter"><code><span class="type">guint32</span> bytes</code></em>);</pre> +<p>Associates the specified identifier with the supplied data.</p> +<p>This procedure associates the supplied data with the provided +identifier. The data may be subsequently retrieved by a call to +'procedural-db-get-data'.</p> +<div class="refsect3"> +<a name="gimp-procedural-db-set-data.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>identifier</p></td> +<td class="parameter_description"><p>The identifier associated with data.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>data</p></td> +<td class="parameter_description"><p>A byte array containing data.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>bytes</p></td> +<td class="parameter_description"><p>The number of bytes in the data</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-procedural-db-set-data.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-procedural-db-dump"></a><h3>gimp_procedural_db_dump ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_procedural_db_dump (<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);</pre> +<p>Dumps the current contents of the procedural database</p> +<p>This procedure dumps the contents of the procedural database to the +specified file. The file will contain all of the information +provided for each registered procedure.</p> +<div class="refsect3"> +<a name="gimp-procedural-db-dump.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>filename</p></td> +<td class="parameter_description"><p>The dump filename.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-procedural-db-dump.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-procedural-db-query"></a><h3>gimp_procedural_db_query ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_procedural_db_query (<em class="parameter"><code>const <span class="type">gchar</span> *name</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *blurb</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *help</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *author</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *copyright</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *date</code></em>, + <em class="parameter"><code>const <span class="type">gchar</span> *proc_type</code></em>, + <em class="parameter"><code><span class="type">gint</span> *num_matches</code></em>, + <em class="parameter"><code><span class="type">gchar</span> ***procedure_names</code></em>);</pre> +<p>Queries the procedural database for its contents using regular +expression matching.</p> +<p>This procedure queries the contents of the procedural database. It +is supplied with seven arguments matching procedures on { name, +blurb, help, author, copyright, date, procedure type}. This is +accomplished using regular expression matching. For instance, to +find all procedures with \"jpeg\" listed in the blurb, all seven +arguments can be supplied as \".*\", except for the second, which +can be supplied as \".*jpeg.*\". There are two return arguments for +this procedure. The first is the number of procedures matching the +query. The second is a concatenated list of procedure names +corresponding to those matching the query. If no matching entries +are found, then the returned string is NULL and the number of +entries is 0.</p> +<div class="refsect3"> +<a name="gimp-procedural-db-query.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>name</p></td> +<td class="parameter_description"><p>The regex for procedure name.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>blurb</p></td> +<td class="parameter_description"><p>The regex for procedure blurb.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>help</p></td> +<td class="parameter_description"><p>The regex for procedure help.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>author</p></td> +<td class="parameter_description"><p>The regex for procedure author.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>copyright</p></td> +<td class="parameter_description"><p>The regex for procedure copyright.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>date</p></td> +<td class="parameter_description"><p>The regex for procedure date.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>proc_type</p></td> +<td class="parameter_description"><p>The regex for procedure type: { 'Internal GIMP procedure', 'GIMP Plug-in', 'GIMP Extension', 'Temporary Procedure' }.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>num_matches</p></td> +<td class="parameter_description"><p>The number of matching procedures.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>procedure_names</p></td> +<td class="parameter_description"><p>The list of procedure names.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-procedural-db-query.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-procedural-db-proc-exists"></a><h3>gimp_procedural_db_proc_exists ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_procedural_db_proc_exists (<em class="parameter"><code>const <span class="type">gchar</span> *procedure_name</code></em>);</pre> +<p>Checks if the specified procedure exists in the procedural database</p> +<p>This procedure checks if the specified procedure is registered in +the procedural database.</p> +<div class="refsect3"> +<a name="gimp-procedural-db-proc-exists.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>procedure_name</p></td> +<td class="parameter_description"><p>The procedure name.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-procedural-db-proc-exists.returns"></a><h4>Returns</h4> +<p> Whether a procedure of that name is registered.</p> +</div> +<p class="since">Since: <a class="link" href="api-index-2-6.html#api-index-2.6">2.6</a></p> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-procedural-db-proc-info"></a><h3>gimp_procedural_db_proc_info ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_procedural_db_proc_info (<em class="parameter"><code>const <span class="type">gchar</span> *procedure</code></em>, + <em class="parameter"><code><span class="type">gchar</span> **blurb</code></em>, + <em class="parameter"><code><span class="type">gchar</span> **help</code></em>, + <em class="parameter"><code><span class="type">gchar</span> **author</code></em>, + <em class="parameter"><code><span class="type">gchar</span> **copyright</code></em>, + <em class="parameter"><code><span class="type">gchar</span> **date</code></em>, + <em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpPDBProcType"><span class="type">GimpPDBProcType</span></a> *proc_type</code></em>, + <em class="parameter"><code><span class="type">gint</span> *num_args</code></em>, + <em class="parameter"><code><span class="type">gint</span> *num_values</code></em>, + <em class="parameter"><code><a class="link" href="libgimp-gimp.html#GimpParamDef" title="GimpParamDef"><span class="type">GimpParamDef</span></a> **args</code></em>, + <em class="parameter"><code><a class="link" href="libgimp-gimp.html#GimpParamDef" title="GimpParamDef"><span class="type">GimpParamDef</span></a> **return_vals</code></em>);</pre> +<p>Queries the procedural database for information on the specified +procedure.</p> +<p>This procedure returns information on the specified procedure. A +short blurb, detailed help, author(s), copyright information, +procedure type, number of input, and number of return values are +returned. Additionally this function returns specific information +about each input argument and return value.</p> +<div class="refsect3"> +<a name="gimp-procedural-db-proc-info.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>procedure</p></td> +<td class="parameter_description"><p>The procedure name.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>blurb</p></td> +<td class="parameter_description"><p>A short blurb.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>help</p></td> +<td class="parameter_description"><p>Detailed procedure help.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>author</p></td> +<td class="parameter_description"><p>Author(s) of the procedure.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>copyright</p></td> +<td class="parameter_description"><p>The copyright.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>date</p></td> +<td class="parameter_description"><p>Copyright date.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>proc_type</p></td> +<td class="parameter_description"><p>The procedure type.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>num_args</p></td> +<td class="parameter_description"><p>The number of input arguments.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>num_values</p></td> +<td class="parameter_description"><p>The number of return values.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>args</p></td> +<td class="parameter_description"><p>The input arguments.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>return_vals</p></td> +<td class="parameter_description"><p>The return values.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-procedural-db-proc-info.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-procedural-db-proc-arg"></a><h3>gimp_procedural_db_proc_arg ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_procedural_db_proc_arg (<em class="parameter"><code>const <span class="type">gchar</span> *procedure_name</code></em>, + <em class="parameter"><code><span class="type">gint</span> arg_num</code></em>, + <em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpPDBArgType"><span class="type">GimpPDBArgType</span></a> *arg_type</code></em>, + <em class="parameter"><code><span class="type">gchar</span> **arg_name</code></em>, + <em class="parameter"><code><span class="type">gchar</span> **arg_desc</code></em>);</pre> +<p>Queries the procedural database for information on the specified +procedure's argument.</p> +<p>This procedure returns information on the specified procedure's +argument. The argument type, name, and a description are retrieved.</p> +<div class="refsect3"> +<a name="gimp-procedural-db-proc-arg.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>procedure_name</p></td> +<td class="parameter_description"><p>The procedure name.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>arg_num</p></td> +<td class="parameter_description"><p>The argument number.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>arg_type</p></td> +<td class="parameter_description"><p>The type of argument.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>arg_name</p></td> +<td class="parameter_description"><p>The name of the argument.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>arg_desc</p></td> +<td class="parameter_description"><p>A description of the argument.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-procedural-db-proc-arg.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-procedural-db-proc-val"></a><h3>gimp_procedural_db_proc_val ()</h3> +<pre class="programlisting"><span class="returnvalue">gboolean</span> +gimp_procedural_db_proc_val (<em class="parameter"><code>const <span class="type">gchar</span> *procedure_name</code></em>, + <em class="parameter"><code><span class="type">gint</span> val_num</code></em>, + <em class="parameter"><code><a href="../html/libgimpbase-gimpbaseenums.html#GimpPDBArgType"><span class="type">GimpPDBArgType</span></a> *val_type</code></em>, + <em class="parameter"><code><span class="type">gchar</span> **val_name</code></em>, + <em class="parameter"><code><span class="type">gchar</span> **val_desc</code></em>);</pre> +<p>Queries the procedural database for information on the specified +procedure's return value.</p> +<p>This procedure returns information on the specified procedure's +return value. The return value type, name, and a description are +retrieved.</p> +<div class="refsect3"> +<a name="gimp-procedural-db-proc-val.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody> +<tr> +<td class="parameter_name"><p>procedure_name</p></td> +<td class="parameter_description"><p>The procedure name.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>val_num</p></td> +<td class="parameter_description"><p>The return value number.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>val_type</p></td> +<td class="parameter_description"><p>The type of return value.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>val_name</p></td> +<td class="parameter_description"><p>The name of the return value.</p></td> +<td class="parameter_annotations"> </td> +</tr> +<tr> +<td class="parameter_name"><p>val_desc</p></td> +<td class="parameter_description"><p>A description of the return value.</p></td> +<td class="parameter_annotations"> </td> +</tr> +</tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-procedural-db-proc-val.returns"></a><h4>Returns</h4> +<p> TRUE on success.</p> +</div> +</div> +<hr> +<div class="refsect2"> +<a name="gimp-procedural-db-get-data-size"></a><h3>gimp_procedural_db_get_data_size ()</h3> +<pre class="programlisting"><span class="returnvalue">gint</span> +gimp_procedural_db_get_data_size (<em class="parameter"><code>const <span class="type">gchar</span> *identifier</code></em>);</pre> +<p>Returns size of data associated with the specified identifier.</p> +<p>This procedure returns the size of any data which may have been +associated with the specified identifier. If no data has been +associated with the identifier, an error is returned.</p> +<div class="refsect3"> +<a name="gimp-procedural-db-get-data-size.parameters"></a><h4>Parameters</h4> +<div class="informaltable"><table class="informaltable" width="100%" border="0"> +<colgroup> +<col width="150px" class="parameters_name"> +<col class="parameters_description"> +<col width="200px" class="parameters_annotations"> +</colgroup> +<tbody><tr> +<td class="parameter_name"><p>identifier</p></td> +<td class="parameter_description"><p>The identifier associated with data.</p></td> +<td class="parameter_annotations"> </td> +</tr></tbody> +</table></div> +</div> +<div class="refsect3"> +<a name="gimp-procedural-db-get-data-size.returns"></a><h4>Returns</h4> +<p> The number of bytes in the data.</p> +</div> +</div> +</div> +</div> +<div class="footer"> +<hr>Generated by GTK-Doc V1.33.1</div> +</body> +</html>
\ No newline at end of file |