rulex

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