1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
|
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
project.
Copyright (C) 1998-2018 OpenLink Software
This project is free software; you can redistribute it and/or modify it
under the terms of the GNU General Public License as published by the
Free Software Foundation; only version 2 of the License, dated June 1991.
This program is distributed in the hope that it will be useful, but
WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
General Public License for more details.
You should have received a copy of the GNU General Public License along
with this program; if not, write to the Free Software Foundation, Inc.,
51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
: template.sh,v 1.4 2006/04/17 22:58:08 ivan Exp $
-->
<refentry id="fn_dict_get">
<refmeta>
<refentrytitle>dict_get</refentrytitle>
<refmiscinfo>dict</refmiscinfo>
</refmeta>
<refnamediv>
<refname>dict_get</refname>
<refpurpose>Returns the dependent part that corresponds to the given key in the given dictionary.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_dict_get">
<funcprototype id="fproto_dict_get">
<funcdef>any <function>dict_get</function></funcdef>
<paramdef>in <parameter>dict</parameter> dictionary</paramdef>
<paramdef>in <parameter>key</parameter> any</paramdef>
<paramdef><optional>in <parameter>default_value</parameter> any</optional></paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_dict_get">
<title>Description</title>
<para>The function returns the dependent part that corresponds to the given key in the given dictionary.
The function returns <parameter>default_value</parameter> if the dictionary does not contain a pair whose key is equivalent to the given one.
When only two arguments are passed to the function the default value is integer zero.</para>
</refsect1>
<refsect1 id="params_dict_get">
<title>Parameters</title>
<refsect2><title>dict</title>
<para>Dictionary object to search in.</para>
</refsect2>
<refsect2><title>key</title>
<para>Key whose dependent part should be found.</para>
</refsect2>
<refsect2><title>default_value</title>
<para>The default value to be returned if the key is not found in the dictionary.</para>
</refsect2>
</refsect1>
<refsect1 id="ret_dict_get"><title>Return Types</title>
<para>The function can return a value of any type.</para>
</refsect1>
<!--
<refsect1 id="examples_dict_get">
<title>Examples</title>
<example id="ex_dict_get"><title></title>
<para></para>
<screen><![CDATA[
]]>
</screen>
</example>
</refsect1>
-->
<refsect1 id="seealso_dict_get">
<title>See Also</title>
<para><link linkend="fn_dict_new"><function>dict_new()</function></link></para>
<para><link linkend="fn_dict_zap"><function>dict_zap()</function></link></para>
<para><link linkend="fn_dict_put"><function>dict_put()</function></link></para>
<para><link linkend="fn_dict_remove"><function>dict_remove()</function></link></para>
<para><link linkend="fn_dict_inc_or_put"><function>dict_inc_or_put()</function></link></para>
<para><link linkend="fn_dict_dec_or_remove"><function>dict_dec_or_remove()</function></link></para>
<para><link linkend="fn_dict_size"><function>dict_size()</function></link></para>
<para><link linkend="fn_dict_duplicate"><function>dict_duplicate()</function></link></para>
<para><link linkend="fn_dict_to_vector"><function>dict_to_vector()</function></link></para>
<para><link linkend="fn_dict_list_keys"><function>dict_list_keys()</function></link></para>
<para><link linkend="fn_dict_destructive_list_rnd_keys"><function>dict_destructive_list_rnd_keys()</function></link></para>
<para><link linkend="fn_dict_iter_rewind"><function>dict_iter_rewind()</function></link></para>
<para><link linkend="fn_dict_iter_next"><function>dict_iter_next()</function></link></para>
</refsect1>
</refentry>
|
