3 <meta name="generator" content="groff -Thtml, see www.gnu.org">
4 <meta name="Content-Style" content="text/css">
5 <title>shash_get</title>
9 <h1 align=center>shash_get</h1>
10 <a href="#NAME">NAME</a><br>
11 <a href="#SYNOPSIS">SYNOPSIS</a><br>
12 <a href="#DESCRIPTION">DESCRIPTION</a><br>
13 <a href="#AUTHOR">AUTHOR</a><br>
14 <a href="#LICENSE">LICENSE</a><br>
15 <a href="#VERSION">VERSION</a><br>
18 <!-- Creator : groff version 1.17.2 -->
19 <!-- CreationDate: Fri May 3 14:58:33 2002 -->
22 <table width="100%" border=0 rules="none" frame="void"
23 cols="2" cellspacing="0" cellpadding="0">
24 <tr valign="top" align="left">
25 <td width="10%"></td><td width="90%">
26 shash_get, _shash_get, shash_get_ptr, _shash_get_ptr, shash_exists - look up in a shash</td></table>
27 <a name="SYNOPSIS"></a>
30 <table width="100%" border=0 rules="none" frame="void"
31 cols="2" cellspacing="0" cellpadding="0">
32 <tr valign="top" align="left">
33 <td width="10%"></td><td width="90%">
34 <pre><b>#include <hash.h>
36 #define shash_get(shash,key,value) _shash_get((shash),(key),&(value))
37 int _shash_get (shash, const char *key, void *value);
38 #define shash_get_ptr(h,key,ptr) _shash_get_ptr ((h),(key),&(ptr))
39 int _shash_get_ptr (shash, const char *key, void **ptr);
40 #define shash_exists(shash,key) _shash_get_ptr ((shash), (key), 0)
41 </b></pre></td></table>
42 <a name="DESCRIPTION"></a>
45 <table width="100%" border=0 rules="none" frame="void"
46 cols="2" cellspacing="0" cellpadding="0">
47 <tr valign="top" align="left">
48 <td width="10%"></td><td width="90%">
49 Get the <b>value</b> associated with key <b>key</b> and
50 return true. If there is no <b>value</b> associated with
51 <b>key</b>, this returns false and <b>value</b> is left
52 unchanged.</td></table>
54 <table width="100%" border=0 rules="none" frame="void"
55 cols="2" cellspacing="0" cellpadding="0">
56 <tr valign="top" align="left">
57 <td width="10%"></td><td width="90%">
58 The <b>*_ptr</b> variants return a pointer rather than
59 copying out the entire value object. The pointer is
60 typically only valid for a short period of time.
61 Particularly if you insert or remove elements from the
62 shash, this pointer may become invalid.</td></table>
64 <table width="100%" border=0 rules="none" frame="void"
65 cols="2" cellspacing="0" cellpadding="0">
66 <tr valign="top" align="left">
67 <td width="10%"></td><td width="90%">
68 <b>shash_exists</b> simply tests whether or not <b>key</b>
69 exists in the shash. If so, it returns true, otherwise
74 <table width="100%" border=0 rules="none" frame="void"
75 cols="2" cellspacing="0" cellpadding="0">
76 <tr valign="top" align="left">
77 <td width="10%"></td><td width="90%">
78 Richard Jones <rich@annexia.org></td></table>
79 <a name="LICENSE"></a>
82 <table width="100%" border=0 rules="none" frame="void"
83 cols="2" cellspacing="0" cellpadding="0">
84 <tr valign="top" align="left">
85 <td width="10%"></td><td width="90%">
86 GNU LGPL (see http://www.gnu.org/)</td></table>
87 <a name="VERSION"></a>
90 <table width="100%" border=0 rules="none" frame="void"
91 cols="2" cellspacing="0" cellpadding="0">
92 <tr valign="top" align="left">
93 <td width="10%"></td><td width="90%">
94 c2lib-1.2.13</td></table>