mirror of
https://gitlab.gnome.org/GNOME/glib.git
synced 2025-03-06 07:54:46 +01:00
24273ca743
Wed Nov 11 18:11:24 EST 1998 Gregory McLean <gregm@comstar.net>
* docs/*.sgml : Batch of new documentation that should be easier
to maintain and extend. Plus generate whatever sort of doc file
you would like. I didn't change the Makefile stuff as I'm not sure
what default doc type people want. Oh and this is all DocBook format.
Enjoy!
263 lines
8.3 KiB
Plaintext
263 lines
8.3 KiB
Plaintext
<!doctype chapter PUBLIC "-//Davenport//DTD DocBook V3.0//EN" []>
|
|
<chapter id="hashtable-functions">
|
|
<docinfo>
|
|
<Title>Hash Table functions</title>
|
|
</docinfo>
|
|
<title>Hash Table functions</title>
|
|
<sect1 id="hashtable-introduction">
|
|
<title>Introduction</title>
|
|
<para> </para>
|
|
</sect1>
|
|
<sect1 id="hash-tables">
|
|
<title>Hash Table functions</title>
|
|
<para> </para>
|
|
<sect2 id="g-hash-table-new">
|
|
<title>g_hash_table_new</title>
|
|
<funcsynopsis>
|
|
<funcdef>GHashTable *<function>g_hash_table_new</function></funcdef>
|
|
<paramdef>GHashFunc *<parameter>hash_func</parameter></paramdef>
|
|
<paramdef>GCompareFunc <parameter>key_compare_func</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<sect3><title>Description</title>
|
|
<para>Allocate a new <type>GHashTable</type> for use and return a
|
|
pointer to the new hash table. If the table could not be allocated
|
|
for some reason a <type>NULL</type> is returned.</para>
|
|
</sect3>
|
|
<sect3><title>Usage</title>
|
|
<programlisting role="C">
|
|
GHashTable *hash_table;
|
|
|
|
hash_table = g_hash_table_new (g_str_hash, g_str_equal);
|
|
|
|
/* use the hash table */
|
|
</programlisting>
|
|
</sect3>
|
|
<sect3><title>Parameters</title>
|
|
<para>GHashFunc <parameter>hash_func</parameter></para>
|
|
<para>A function pointer for the hashing function for this hash table.
|
|
</para>
|
|
<para>GCompareFunc <parameter>key_compare_func</parameter></para>
|
|
<para>A function pointer for comparing keys, used by the hash function
|
|
specified in the first argument</para>
|
|
</sect3>
|
|
</sect2>
|
|
<sect2 id="g-hash-table-destroy">
|
|
<title>g_hash_table_destroy</title>
|
|
<funcsynopsis>
|
|
<funcdef>void <function>g_hash_table_destroy</function></funcdef>
|
|
<paramdef>GHashTable *<parameter>hash_table</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<sect3><title>Description</title>
|
|
<para> </para>
|
|
</sect3>
|
|
<sect3><title>Usage</title>
|
|
<programlisting role="C">
|
|
|
|
</programlisting>
|
|
</sect3>
|
|
<sect3><title>Parameters</title>
|
|
<para>GHashTable *<parameter>hash_table</parameter></para>
|
|
<para> </para>
|
|
</sect3>
|
|
</sect2>
|
|
<sect2 id="g-hash-table-insert">
|
|
<title>g_hash_table_insert</title>
|
|
<funcsynopsis>
|
|
<funcdef>void <function>g_hash_table_insert</function></funcdef>
|
|
<paramdef>GHashTable *<parameter>hash_table</parameter></paramdef>
|
|
<paramdef>gpointer <parameter>key</parameter></paramdef>
|
|
<paramdef>gpointer <parameter>value</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<sect3><title>Description</title>
|
|
<para> </para>
|
|
</sect3>
|
|
<sect3><title>Usage</title>
|
|
<programlisting role="C">
|
|
|
|
</programlisting>
|
|
</sect3>
|
|
<sect3><title>Parameters</title>
|
|
<para>GHashTable *<parameter>hash_table</parameter></para>
|
|
<para> </para>
|
|
</sect3>
|
|
</sect2>
|
|
<sect2 id="g-hash-table-remove">
|
|
<title>g_hash_table_remove</title>
|
|
<funcsynopsis>
|
|
<funcdef>void <function>g_hash_table_remove</function></funcdef>
|
|
<paramdef>GHashTable *<parameter>hash_table</parameter></paramdef>
|
|
<paramdef>gconstpointer <parameter>key</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<sect3><title>Description</title>
|
|
<para> </para>
|
|
</sect3>
|
|
<sect3><title>Usage</title>
|
|
<programlisting role="C">
|
|
|
|
</programlisting>
|
|
</sect3>
|
|
<sect3><title>Parameters</title>
|
|
<para>GHashTable *<parameter>hash_table</parameter></para>
|
|
<para> </para>
|
|
</sect3>
|
|
</sect2>
|
|
<sect2 id="g-hash-table-lookup">
|
|
<title>g_hash_table_lookup</title>
|
|
<funcsynopsis>
|
|
<funcdef>gpointer <function>g_hash_table_lookup</function></funcdef>
|
|
<paramdef>gconstpointer <parameter>key</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<sect3><title>Description</title>
|
|
<para> </para>
|
|
</sect3>
|
|
<sect3><title>Usage</title>
|
|
<programlisting role="C">
|
|
|
|
</programlisting>
|
|
</sect3>
|
|
<sect3><title>Parameters</title>
|
|
<para>GHashTable *<parameter>hash_table</parameter></para>
|
|
<para> </para>
|
|
</sect3>
|
|
</sect2>
|
|
<sect2 id="g-hash-table-lookup-extended">
|
|
<title>g_hash_table_lookup_extended</title>
|
|
<funcsynopsis>
|
|
<funcdef>gboolean <function>g_hash_table_lookup_extended</function></funcdef>
|
|
<paramdef>GHashTable *<parameter>hash_table</parameter></paramdef>
|
|
<paramdef>gconstpointer <parameter>lookup_key</parameter></paramdef>
|
|
<paramdef>gpointer *<parameter>orig_key</parameter></paramdef>
|
|
<paramdef>gpointer *<parameter>value</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<sect3><title>Description</title>
|
|
<para> </para>
|
|
</sect3>
|
|
<sect3><title>Usage</title>
|
|
<programlisting role="C">
|
|
|
|
</programlisting>
|
|
</sect3>
|
|
<sect3><title>Parameters</title>
|
|
<para>GHashTable *<parameter>hash_table</parameter></para>
|
|
<para> </para>
|
|
</sect3>
|
|
</sect2>
|
|
<sect2 id="g-hash-table-freeze">
|
|
<title>g_hash_table_freeze</title>
|
|
<funcsynopsis>
|
|
<funcdef>void <function>g_hash_table_freeze</function></funcdef>
|
|
<paramdef>GHashTable *<parameter>hash_table</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<sect3><title>Description</title>
|
|
<para> </para>
|
|
</sect3>
|
|
<sect3><title>Usage</title>
|
|
<programlisting role="C">
|
|
|
|
</programlisting>
|
|
</sect3>
|
|
<sect3><title>Parameters</title>
|
|
<para>GHashTable *<parameter>hash_table</parameter></para>
|
|
<para> </para>
|
|
</sect3>
|
|
</sect2>
|
|
<sect2 id="g-hash-table-thaw">
|
|
<title>g_hash_table_thaw</title>
|
|
<funcsynopsis>
|
|
<funcdef>void <function>g_hash_table_thaw</function></funcdef>
|
|
<paramdef>GHashTable *<parameter>hash_table</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<sect3><title>Description</title>
|
|
<para> </para>
|
|
</sect3>
|
|
<sect3><title>Usage</title>
|
|
<programlisting role="C">
|
|
|
|
</programlisting>
|
|
</sect3>
|
|
<sect3><title>Parameters</title>
|
|
<para>GHashTable *<parameter>hash_table</parameter></para>
|
|
<para> </para>
|
|
</sect3>
|
|
</sect2>
|
|
<sect2 id="g-hash-table-foreach">
|
|
<title>g_hash_table_foreach</title>
|
|
<funcsynopsis>
|
|
<funcdef>void <function>g_hash_table_foreach</function></funcdef>
|
|
<paramdef>GHashTable *<parameter>hash_table</parameter></paramdef>
|
|
<paramdef>GHFunc <parameter>func</parameter></paramdef>
|
|
<paramdef>gpointer <parameter>user_data</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<sect3><title>Description</title>
|
|
<para> </para>
|
|
</sect3>
|
|
<sect3><title>Usage</title>
|
|
<programlisting role="C">
|
|
|
|
</programlisting>
|
|
</sect3>
|
|
<sect3><title>Parameters</title>
|
|
<para>GHashTable *<parameter>hash_table</parameter></para>
|
|
<para> </para>
|
|
</sect3>
|
|
</sect2>
|
|
<sect2 id="g-hash-table-foreach-remove">
|
|
<title>g_hash_table_foreach_remove</title>
|
|
<funcsynopsis>
|
|
<funcdef>gint <function>g_hash_table_foreach_remove</function></funcdef>
|
|
<paramdef>GHashTable *<parameter>hash_table</parameter></paramdef>
|
|
<paramdef>GHRFunc <parameter>func</parameter></paramdef>
|
|
<paramdef>gpointer <parameter>user_data</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<sect3><title>Description</title>
|
|
<para> </para>
|
|
</sect3>
|
|
<sect3><title>Usage</title>
|
|
<programlisting role="C">
|
|
|
|
</programlisting>
|
|
</sect3>
|
|
<sect3><title>Parameters</title>
|
|
<para>GHashTable *<parameter>hash_table</parameter></para>
|
|
<para> </para>
|
|
</sect3>
|
|
</sect2>
|
|
<sect2 id="g-hash-table-size">
|
|
<title>g_hash_table_size</title>
|
|
<funcsynopsis>
|
|
<funcdef>gint <function>g_hash_table_size</function></funcdef>
|
|
<paramdef>GHashTable *<parameter>hash_table</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<sect3><title>Description</title>
|
|
<para>Get the size of the hash table passed in the
|
|
<parameter>hash_table</parameter>.</para>
|
|
</sect3>
|
|
<sect3><title>Usage</title>
|
|
<programlisting role="C">
|
|
|
|
</programlisting>
|
|
</sect3>
|
|
<sect3><title>Parameters</title>
|
|
<para>GHashTable *<parameter>hash_table</parameter></para>
|
|
<para>A pointer to a <type>GHashTable</type> hash_table previously
|
|
allocated.</para>
|
|
</sect3>
|
|
</sect2>
|
|
</sect1>
|
|
</chapter>
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:2
|
|
sgml-indent-data:t
|
|
sgml-parent-document:("glib.sgml" "book" "sect1" "")
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
-->
|