rulex

1
.\"                                      Hey, EMACS: -*- nroff -*-
2
.TH RULEXDB_LEXBASE 3 "February 20, 2012"
3
.SH NAME
4
rulexdb_lexbase \- try to find lexical base for the specified word
5
.SH SYNOPSIS
6
.nf
7
.B #include <rulexdb.h>
8
.sp
9
.BI "int rulexdb_lexbase(RULEXDB *" rulexdb ", const char *" s \
10
", char *" t ", int " n );
11
.fi
12
.SH DESCRIPTION
13
The
14
.BR rulexdb_lexbase ()
15
function scans \fBClassifiers\fP ruleset starting from
16
.I n
17
which must be positive trying to match the word pointed by
18
.IR s .
19
When match succeeds, the lexical base is constructed in memory area
20
 pointed by
21
.IR t ,
22
which must have enough space for it, and the number of matched rule or
23
0 if no match found is returned.
24
.PP
25
The argument
26
.I rulexdb
27
references the rulex database to search in.
28
.SH "RETURN VALUE"
29
The
30
.BR rulexdb_lexbase ()
31
function returns the number of matched rule that is always positive, 0
32
when no match found, or negative error code.
33
.SH ERRORS
34
.TP
35
.B RULEXDB_FAILURE
36
Referenced database has not been opened, internal data structures are
37
corrupted or some other general failure has occurred.
38
.TP
39
.B RULEXDB_EMALLOC
40
Internal memory allocation error.
41
.TP
42
.B RULEXDB_EPARM
43
Invalid parameters are specified.
44
.SH SEE ALSO
45
.BR rulexdb_classify (3),
46
.BR rulexdb_close (3),
47
.BR rulexdb_dataset_name (3),
48
.BR rulexdb_discard_dictionary (3),
49
.BR rulexdb_discard_ruleset (3),
50
.BR rulexdb_fetch_rule (3),
51
.BR rulexdb_load_ruleset (3),
52
.BR rulexdb_open (3),
53
.BR rulexdb_remove_item (3),
54
.BR rulexdb_remove_rule (3),
55
.BR rulexdb_remove_this_item (3),
56
.BR rulexdb_retrieve_item (3),
57
.BR rulexdb_search (3),
58
.BR rulexdb_seq (3),
59
.BR rulexdb_subscribe_item (3),
60
.BR rulexdb_subscribe_rule (3)
61
.SH AUTHOR
62
Igor B. Poretsky <poretsky@mlbox.ru>.
63