rulex

1
.\"                                      Hey, EMACS: -*- nroff -*-
2
.TH RULEXDB_CLASSIFY 3 "February 21, 2012"
3
.SH NAME
4
rulexdb_classify \- test specified word whether it represents a lexical base
5
.SH SYNOPSIS
6
.nf
7
.B #include <rulexdb.h>
8
.sp
9
.BI "int rulexdb_classify(RULEXDB *" rulexdb ", const char *" s );
10
.fi
11
.SH DESCRIPTION
12
The
13
.BR rulexdb_classify ()
14
function tests the word pointed by
15
.I s
16
argument trying to determine if it can be treated as a lexical base
17
according to the rulex database referenced by
18
.I rulexdb
19
argument.
20
.SH "RETURN VALUE"
21
The
22
.BR rulexdb_classify ()
23
function returns
24
.B RULEXDB_SUCCESS
25
which is zero when the word represents no lexical base,
26
positive value
27
.B RULEXDB_SPECIAL
28
when the word can be treated as a lexical base, or
29
negative error code if something is wrong.
30
.SH ERRORS
31
.TP
32
.B RULEXDB_FAILURE
33
Referenced database has not been opened, internal data structures are
34
corrupted or some other general failure has occurred.
35
.TP
36
.B RULEXDB_EMALLOC
37
Internal memory allocation error.
38
.TP
39
.B RULEXDB_EPARM
40
Invalid parameters are specified.
41
.SH SEE ALSO
42
.BR rulexdb_close (3),
43
.BR rulexdb_dataset_name (3),
44
.BR rulexdb_discard_dictionary (3),
45
.BR rulexdb_discard_ruleset (3),
46
.BR rulexdb_fetch_rule (3),
47
.BR rulexdb_lexbase (3),
48
.BR rulexdb_load_ruleset (3),
49
.BR rulexdb_open (3),
50
.BR rulexdb_remove_item (3),
51
.BR rulexdb_remove_rule (3),
52
.BR rulexdb_remove_this_item (3),
53
.BR rulexdb_retrieve_item (3),
54
.BR rulexdb_search (3),
55
.BR rulexdb_seq (3),
56
.BR rulexdb_subscribe_item (3),
57
.BR rulexdb_subscribe_rule (3)
58
.SH AUTHOR
59
Igor B. Poretsky <poretsky@mlbox.ru>.
60