rulex

1
.\"                                      Hey, EMACS: -*- nroff -*-
2
.TH RULEXDB_REMOVE_ITEM 3 "February 20, 2012"
3
.SH NAME
4
rulexdb_remove_item \- remove specified item from the rulex dictionary
5
.SH SYNOPSIS
6
.nf
7
.B #include <rulexdb.h>
8
.sp
9
.BI "int rulexdb_remove_item(RULEXDB *" rulexdb ", const char *" key \
10
", int " item_type );
11
.fi
12
.SH DESCRIPTION
13
The
14
.BR rulexdb_remove_item ()
15
function removes lexical item for specified
16
.I key
17
from the dictionary dataset defined by
18
.I item_type
19
argument that may accept one of the following values:
20
.TP
21
.B RULEXDB_LEXBASE
22
Remove item from the \fBImplicit\fP dictionary.
23
.TP
24
.B RULEXDB_EXCEPTION
25
Remove item from the \fBExplicit\fP dictionary.
26
.PP
27
Note that the data type must be specified explicitly. The value
28
.B RULEXDB_DEFAULT
29
is not allowed here.
30
.PP
31
The argument
32
.I rulexdb
33
references the database to deal with.
34
.SH "RETURN VALUE"
35
The
36
.BR rulexdb_remove_item ()
37
function returns
38
.B RULEXDB_SUCCESS
39
which is zero when specified item was successfully removed, positive
40
value
41
.B RULEXDB_SPECIAL
42
when no record exists for specified key, or negative error code in the
43
case of other failure.
44
.SH ERRORS
45
.TP
46
.B RULEXDB_FAILURE
47
Referenced database has not been opened, internal data structures are
48
corrupted or some other general failure has occurred.
49
.TP
50
.B RULEXDB_EINVKEY
51
Invalid key specified.
52
.TP
53
.B RULEXDB_EPARM
54
The argument
55
.I rulexdb
56
or
57
.I item_type
58
has an invalid value.
59
.TP
60
.B RULEXDB_EACCESS
61
The database is not opened for updating.
62
.SH SEE ALSO
63
.BR rulexdb_classify (3),
64
.BR rulexdb_close (3),
65
.BR rulexdb_dataset_name (3),
66
.BR rulexdb_discard_dictionary (3),
67
.BR rulexdb_discard_ruleset (3),
68
.BR rulexdb_fetch_rule (3),
69
.BR rulexdb_lexbase (3),
70
.BR rulexdb_load_ruleset (3),
71
.BR rulexdb_open (3),
72
.BR rulexdb_remove_rule (3),
73
.BR rulexdb_remove_this_item (3),
74
.BR rulexdb_retrieve_item (3),
75
.BR rulexdb_search (3),
76
.BR rulexdb_seq (3),
77
.BR rulexdb_subscribe_item (3),
78
.BR rulexdb_subscribe_rule (3)
79
.SH AUTHOR
80
Igor B. Poretsky <poretsky@mlbox.ru>.
81