rulex

1
.\"                                      Hey, EMACS: -*- nroff -*-
2
.TH RULEXDB_RETRIEVE_ITEM 3 "June 22, 2023"
3
.SH NAME
4
rulexdb_retrieve_item \- retrieve an item from the rulex database
5
.SH SYNOPSIS
6
.nf
7
.B #include <rulexdb.h>
8
.sp
9
.BI "int rulexdb_retrieve_item(RULEXDB *" rulexdb \
10
", const char *" key ", char *" value ", int " item_type );
11
.fi
12
.SH DESCRIPTION
13
The
14
.BR rulexdb_retrieve_item ()
15
function retrieves an item from one of the dictionary datasets in the
16
database referenced by
17
.I rulexdb
18
argument.
19
.PP
20
The argument
21
.I key
22
points to a text string containing the word to be fetched.
23
.PP
24
The argument
25
.I value
26
points to the memory area where corresponding pronunciation string
27
will be placed.
28
.PP
29
The argument
30
.I item_type
31
specifies target dataset. It may accept one of the following values:
32
.TP
33
.B RULEXDB_LEXBASE
34
The item should be fetched from the \fBImplicit\fP dictionary and,
35
therefore, it represents a lexical base.
36
.TP
37
.B RULEXDB_EXCEPTION
38
The item representing an exception should be fetched from the
39
\fBExplicit\fP dictionary.
40
.TP
41
.B RULEXDB_DEFAULT
42
Target dictionary should be guessed according to the key specified: if
43
it represents any lexical base, then \fBImplicit\fP dictionary will be
44
chosen, otherwise the \fBExplicit\fP dictionary will be used.
45
.SH "RETURN VALUE"
46
The
47
.BR rulexdb_retrieve_item ()
48
function returns
49
.B RULEXDB_SUCCESS
50
which is zero when specified item was successfully retrieved, positive
51
value
52
.B RULEXDB_SPECIAL
53
when specified key does not exist in the dictionary, or
54
negative error code otherwise.
55
.SH ERRORS
56
.TP
57
.B RULEXDB_FAILURE
58
Referenced database has not been opened, internal data structures are
59
corrupted or some other general failure has occurred.
60
.TP
61
.B RULEXDB_EINVKEY
62
Invalid key specified.
63
.TP
64
.B RULEXDB_EPARM
65
The argument
66
.I rulexdb
67
or
68
.I item_type
69
has an invalid value.
70
.SH SEE ALSO
71
.BR rulexdb_classify (3),
72
.BR rulexdb_close (3),
73
.BR rulexdb_dataset_name (3),
74
.BR rulexdb_discard_dictionary (3),
75
.BR rulexdb_discard_ruleset (3),
76
.BR rulexdb_fetch_rule (3),
77
.BR rulexdb_lexbase (3),
78
.BR rulexdb_load_ruleset (3),
79
.BR rulexdb_open (3),
80
.BR rulexdb_remove_item (3),
81
.BR rulexdb_remove_rule (3),
82
.BR rulexdb_remove_this_item (3),
83
.BR rulexdb_search (3),
84
.BR rulexdb_seq (3),
85
.BR rulexdb_subscribe_item (3),
86
.BR rulexdb_subscribe_rule (3)
87
.SH AUTHOR
88
Igor B. Poretsky <poretsky@mlbox.ru>.
89