rulex

1
.\"                                      Hey, EMACS: -*- nroff -*-
2
.TH RULEXDB_REMOVE_RULE 3 "February 19, 2012"
3
.SH NAME
4
rulexdb_remove_rule \- remove specified rule from the rulex database
5
.SH SYNOPSIS
6
.nf
7
.B #include <rulexdb.h>
8
.sp
9
.BI "int rulexdb_remove_rule(RULEXDB *" rulexdb ", int " rule_type \
10
", int " position );
11
.fi
12
.SH DESCRIPTION
13
The
14
.BR rulexdb_remove_rule ()
15
function removes a rule identified by its type and position in the
16
ruleset from the rulex database
17
referenced by
18
.I rulexdb
19
argument.
20
.PP
21
The argument
22
.I rule_type
23
specifies the rule type. It may accept one of the following values:
24
.TP
25
.B RULEXDB_LEXCLASS
26
The rule is the word classifier and belongs to the \fBClassifiers\fP
27
dataset.
28
.TP
29
.B RULEXDB_PREFIX
30
The requested rule should be removed from the \fBPrefix detectors\fP
31
ruleset.
32
.TP
33
.B RULEXDB_RULE
34
The requested rule should be removed from the \fBGeneral\fP rules
35
dataset.
36
.TP
37
.B RULEXDB_CORRECTOR
38
The rule is a correction rule that belongs to the \fBCorrectors\fP
39
dataset.
40
.PP
41
The argument
42
.I position
43
defines position of the requested rule in the ruleset.
44
.SH "RETURN VALUE"
45
The
46
.BR rulexdb_remove_rule ()
47
function returns
48
.B RULEXDB_SUCCESS
49
which is zero when specified rule was successfully removed, positive
50
value
51
.B RULEXDB_SPECIAL
52
when there is no rule with such number in specified ruleset, or
53
negative error code otherwise.
54
.SH ERRORS
55
.TP
56
.B RULEXDB_FAILURE
57
Referenced database has not been opened, internal data structures are
58
corrupted or some other general failure has occurred.
59
.TP
60
.B RULEXDB_EPARM
61
The argument
62
.I rulexdb
63
or
64
.I rule_type
65
has an invalid value.
66
.TP
67
.B RULEXDB_EACCESS
68
The database is not opened for updating.
69
.SH SEE ALSO
70
.BR rulexdb_classify (3),
71
.BR rulexdb_close (3),
72
.BR rulexdb_dataset_name (3),
73
.BR rulexdb_discard_dictionary (3),
74
.BR rulexdb_discard_ruleset (3),
75
.BR rulexdb_fetch_rule (3),
76
.BR rulexdb_lexbase (3),
77
.BR rulexdb_load_ruleset (3),
78
.BR rulexdb_open (3),
79
.BR rulexdb_remove_item (3),
80
.BR rulexdb_remove_this_item (3),
81
.BR rulexdb_retrieve_item (3),
82
.BR rulexdb_search (3),
83
.BR rulexdb_seq (3),
84
.BR rulexdb_subscribe_item (3),
85
.BR rulexdb_subscribe_rule (3)
86
.SH AUTHOR
87
Igor B. Poretsky <poretsky@mlbox.ru>.
88