rulex

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