File: dictSearch.3

package info (click to toggle)
clearsilver 0.10.5-3
  • links: PTS
  • area: main
  • in suites: buster
  • size: 3,304 kB
  • ctags: 3,158
  • sloc: ansic: 24,586; python: 4,233; sh: 2,502; cs: 1,429; ruby: 819; java: 735; makefile: 593; perl: 120; lisp: 34; sql: 21
file content (45 lines) | stat: -rw-r--r-- 1,006 bytes parent folder | download | duplicates (6)
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
.TH dictSearch 3 "12 July 2007" "ClearSilver" "util/dict.h"

.de Ss
.sp
.ft CW
.nf
..
.de Se
.fi
.ft P
.sp
..
.SH NAME
dictSearch  - search for value in dictionary.
.SH SYNOPSIS
.Ss
#include <util/dict.h>
.Se
.Ss
void *dictSearch(dictCtx dict, const char *id, void **plock);

.Se

.SH ARGUMENTS
dict - dictionary to search in.
.br
id - identifier of item to find.
.br
plock - place for value lock (or NULL).

.SH DESCRIPTION
Searches for <id> in <dict>, and returns value if 
found, or NULL if not.  If <plock> is non-NULL, then
the lock returned in <plock> will be associated with
the returned value.  Until this lock is passed to
dictReleaseLock(), the value will not be passed to the
dictCleanupFunc callback (see dictCleanup()).

MT-Level: Safe if <dict> thread-safe.

.SH "RETURN VALUE"
plock - set to value lock.

.SH "SEE ALSO"
.BR dictDestroy "(3), "dictCleanup "(3), "dictReleaseLock "(3), "dictRemove "(3), "dictNext "(3), "dictCreate "(3), "dictSetValue "(3), "dictModifyValue "(3), "dictSearch