rulex

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