Release 1.0.3
[platform/upstream/gsignond.git] / docs / html / gsignond-Utility-functions.html
index 016b8d8..3ce1362 100644 (file)
@@ -42,7 +42,7 @@
 <tbody>
 <tr>
 <td class="function_type">
-<span class="returnvalue">gboolean</span>
+<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 </td>
 <td class="function_name">
 <a class="link" href="gsignond-Utility-functions.html#gsignond-wipe-file" title="gsignond_wipe_file ()">gsignond_wipe_file</a> <span class="c_punctuation">()</span>
@@ -50,7 +50,7 @@
 </tr>
 <tr>
 <td class="function_type">
-<span class="returnvalue">gboolean</span>
+<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 </td>
 <td class="function_name">
 <a class="link" href="gsignond-Utility-functions.html#gsignond-wipe-directory" title="gsignond_wipe_directory ()">gsignond_wipe_directory</a> <span class="c_punctuation">()</span>
@@ -58,7 +58,7 @@
 </tr>
 <tr>
 <td class="function_type">
-<span class="returnvalue">gchar</span> *
+<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 </td>
 <td class="function_name">
 <a class="link" href="gsignond-Utility-functions.html#gsignond-generate-nonce" title="gsignond_generate_nonce ()">gsignond_generate_nonce</a> <span class="c_punctuation">()</span>
@@ -66,7 +66,7 @@
 </tr>
 <tr>
 <td class="function_type">
-<span class="returnvalue">GVariant</span> *
+<a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *
 </td>
 <td class="function_name">
 <a class="link" href="gsignond-Utility-functions.html#gsignond-sequence-to-variant" title="gsignond_sequence_to_variant ()">gsignond_sequence_to_variant</a> <span class="c_punctuation">()</span>
@@ -74,7 +74,7 @@
 </tr>
 <tr>
 <td class="function_type">
-<span class="returnvalue">GSequence</span> *
+<a href="http://library.gnome.org/devel/glib/unstable/glib-Sequences.html#GSequence"><span class="returnvalue">GSequence</span></a> *
 </td>
 <td class="function_name">
 <a class="link" href="gsignond-Utility-functions.html#gsignond-variant-to-sequence" title="gsignond_variant_to_sequence ()">gsignond_variant_to_sequence</a> <span class="c_punctuation">()</span>
@@ -82,7 +82,7 @@
 </tr>
 <tr>
 <td class="function_type">
-<span class="returnvalue">gchar</span> **
+<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **
 </td>
 <td class="function_name">
 <a class="link" href="gsignond-Utility-functions.html#gsignond-sequence-to-array" title="gsignond_sequence_to_array ()">gsignond_sequence_to_array</a> <span class="c_punctuation">()</span>
@@ -90,7 +90,7 @@
 </tr>
 <tr>
 <td class="function_type">
-<span class="returnvalue">GSequence</span> *
+<a href="http://library.gnome.org/devel/glib/unstable/glib-Sequences.html#GSequence"><span class="returnvalue">GSequence</span></a> *
 </td>
 <td class="function_name">
 <a class="link" href="gsignond-Utility-functions.html#gsignond-array-to-sequence" title="gsignond_array_to_sequence ()">gsignond_array_to_sequence</a> <span class="c_punctuation">()</span>
@@ -98,7 +98,7 @@
 </tr>
 <tr>
 <td class="function_type">
-<span class="returnvalue">GSequence</span> *
+<a href="http://library.gnome.org/devel/glib/unstable/glib-Sequences.html#GSequence"><span class="returnvalue">GSequence</span></a> *
 </td>
 <td class="function_name">
 <a class="link" href="gsignond-Utility-functions.html#gsignond-copy-array-to-sequence" title="gsignond_copy_array_to_sequence ()">gsignond_copy_array_to_sequence</a> <span class="c_punctuation">()</span>
 </tr>
 <tr>
 <td class="function_type">
-<span class="returnvalue">gboolean</span>
+<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
 </td>
 <td class="function_name">
 <a class="link" href="gsignond-Utility-functions.html#gsignond-is-host-in-domain" title="gsignond_is_host_in_domain ()">gsignond_is_host_in_domain</a> <span class="c_punctuation">()</span>
 <a name="gsignond-Utility-functions.functions_details"></a><h2>Functions</h2>
 <div class="refsect2">
 <a name="gsignond-wipe-file"></a><h3>gsignond_wipe_file ()</h3>
-<pre class="programlisting"><span class="returnvalue">gboolean</span>
-gsignond_wipe_file (<em class="parameter"><code>const <span class="type">gchar</span> *filename</code></em>);</pre>
+<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
+gsignond_wipe_file (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *filename</code></em>);</pre>
 <p>This function securely wipes the contents of the file, by overwriting it with
 0's, then 1's, then random data. The file is then removed.</p>
 <div class="refsect3">
@@ -161,8 +161,8 @@ gsignond_wipe_file (<em class="parameter"><code>const <span class="type">gchar</
 <hr>
 <div class="refsect2">
 <a name="gsignond-wipe-directory"></a><h3>gsignond_wipe_directory ()</h3>
-<pre class="programlisting"><span class="returnvalue">gboolean</span>
-gsignond_wipe_directory (<em class="parameter"><code>const <span class="type">gchar</span> *dirname</code></em>);</pre>
+<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
+gsignond_wipe_directory (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *dirname</code></em>);</pre>
 <p>This function securely wipes the contents of the directory by calling
 <a class="link" href="gsignond-Utility-functions.html#gsignond-wipe-file" title="gsignond_wipe_file ()"><code class="function">gsignond_wipe_file()</code></a> on each file. It also removes links and empty directories but 
 does not recursively wipe them.</p>
@@ -190,7 +190,7 @@ does not recursively wipe them.</p>
 <hr>
 <div class="refsect2">
 <a name="gsignond-generate-nonce"></a><h3>gsignond_generate_nonce ()</h3>
-<pre class="programlisting"><span class="returnvalue">gchar</span> *
+<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> *
 gsignond_generate_nonce ();</pre>
 <p>This function generates a random secure nonce using SHA1 HMAC.</p>
 <div class="refsect3">
@@ -202,8 +202,8 @@ gsignond_generate_nonce ();</pre>
 <hr>
 <div class="refsect2">
 <a name="gsignond-sequence-to-variant"></a><h3>gsignond_sequence_to_variant ()</h3>
-<pre class="programlisting"><span class="returnvalue">GVariant</span> *
-gsignond_sequence_to_variant (<em class="parameter"><code><span class="type">GSequence</span> *seq</code></em>);</pre>
+<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="returnvalue">GVariant</span></a> *
+gsignond_sequence_to_variant (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Sequences.html#GSequence"><span class="type">GSequence</span></a> *seq</code></em>);</pre>
 <p>Convert a string sequence to a variant.</p>
 <div class="refsect3">
 <a name="id-1.8.4.7.5.5"></a><h4>Parameters</h4>
@@ -222,15 +222,15 @@ gsignond_sequence_to_variant (<em class="parameter"><code><span class="type">GSe
 </div>
 <div class="refsect3">
 <a name="id-1.8.4.7.5.6"></a><h4>Returns</h4>
-<p> <span class="type">GVariant</span> of type "as". </p>
+<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> of type "as". </p>
 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 </div>
 </div>
 <hr>
 <div class="refsect2">
 <a name="gsignond-variant-to-sequence"></a><h3>gsignond_variant_to_sequence ()</h3>
-<pre class="programlisting"><span class="returnvalue">GSequence</span> *
-gsignond_variant_to_sequence (<em class="parameter"><code><span class="type">GVariant</span> *var</code></em>);</pre>
+<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Sequences.html#GSequence"><span class="returnvalue">GSequence</span></a> *
+gsignond_variant_to_sequence (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-GVariant.html#GVariant"><span class="type">GVariant</span></a> *var</code></em>);</pre>
 <p>Convert variant containing string array to sequence.</p>
 <div class="refsect3">
 <a name="id-1.8.4.7.6.5"></a><h4>Parameters</h4>
@@ -249,15 +249,15 @@ gsignond_variant_to_sequence (<em class="parameter"><code><span class="type">GVa
 </div>
 <div class="refsect3">
 <a name="id-1.8.4.7.6.6"></a><h4>Returns</h4>
-<p> <span class="type">GSequence</span> of strings. </p>
+<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Sequences.html#GSequence"><span class="type">GSequence</span></a> of strings. </p>
 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 </div>
 </div>
 <hr>
 <div class="refsect2">
 <a name="gsignond-sequence-to-array"></a><h3>gsignond_sequence_to_array ()</h3>
-<pre class="programlisting"><span class="returnvalue">gchar</span> **
-gsignond_sequence_to_array (<em class="parameter"><code><span class="type">GSequence</span> *seq</code></em>);</pre>
+<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="returnvalue">gchar</span></a> **
+gsignond_sequence_to_array (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Sequences.html#GSequence"><span class="type">GSequence</span></a> *seq</code></em>);</pre>
 <p>Convert sequence of strings to null-terminated string array.</p>
 <div class="refsect3">
 <a name="id-1.8.4.7.7.5"></a><h4>Parameters</h4>
@@ -283,8 +283,8 @@ gsignond_sequence_to_array (<em class="parameter"><code><span class="type">GSequ
 <hr>
 <div class="refsect2">
 <a name="gsignond-array-to-sequence"></a><h3>gsignond_array_to_sequence ()</h3>
-<pre class="programlisting"><span class="returnvalue">GSequence</span> *
-gsignond_array_to_sequence (<em class="parameter"><code><span class="type">gchar</span> **items</code></em>);</pre>
+<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Sequences.html#GSequence"><span class="returnvalue">GSequence</span></a> *
+gsignond_array_to_sequence (<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **items</code></em>);</pre>
 <p>Convert null-terminated array of strings to a sequence.</p>
 <div class="refsect3">
 <a name="id-1.8.4.7.8.5"></a><h4>Parameters</h4>
@@ -303,15 +303,15 @@ gsignond_array_to_sequence (<em class="parameter"><code><span class="type">gchar
 </div>
 <div class="refsect3">
 <a name="id-1.8.4.7.8.6"></a><h4>Returns</h4>
-<p> <span class="type">GSequence</span> of strings. </p>
+<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Sequences.html#GSequence"><span class="type">GSequence</span></a> of strings. </p>
 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 </div>
 </div>
 <hr>
 <div class="refsect2">
 <a name="gsignond-copy-array-to-sequence"></a><h3>gsignond_copy_array_to_sequence ()</h3>
-<pre class="programlisting"><span class="returnvalue">GSequence</span> *
-gsignond_copy_array_to_sequence (<em class="parameter"><code>const <span class="type">gchar</span> **items</code></em>);</pre>
+<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Sequences.html#GSequence"><span class="returnvalue">GSequence</span></a> *
+gsignond_copy_array_to_sequence (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> **items</code></em>);</pre>
 <p>Copy null-terminated array of strings to a sequence.</p>
 <div class="refsect3">
 <a name="id-1.8.4.7.9.5"></a><h4>Parameters</h4>
@@ -330,16 +330,16 @@ gsignond_copy_array_to_sequence (<em class="parameter"><code>const <span class="
 </div>
 <div class="refsect3">
 <a name="id-1.8.4.7.9.6"></a><h4>Returns</h4>
-<p> <span class="type">GSequence</span> of strings. </p>
+<p> <a href="http://library.gnome.org/devel/glib/unstable/glib-Sequences.html#GSequence"><span class="type">GSequence</span></a> of strings. </p>
 <p><span class="annotation">[<acronym title="Free data after the code is done."><span class="acronym">transfer full</span></acronym>]</span></p>
 </div>
 </div>
 <hr>
 <div class="refsect2">
 <a name="gsignond-is-host-in-domain"></a><h3>gsignond_is_host_in_domain ()</h3>
-<pre class="programlisting"><span class="returnvalue">gboolean</span>
-gsignond_is_host_in_domain (<em class="parameter"><code>const <span class="type">gchar</span> *host</code></em>,
-                            <em class="parameter"><code>const <span class="type">gchar</span> *domain</code></em>);</pre>
+<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a>
+gsignond_is_host_in_domain (<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *host</code></em>,
+                            <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *domain</code></em>);</pre>
 <p>Checks if <em class="parameter"><code>host</code></em>
  belongs to <em class="parameter"><code>domain</code></em>
 .</p>