rulex

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