rulex

1
.\"                                      Hey, EMACS: -*- nroff -*-
2
.TH RULEXDB_DATASET_NAME 3 "February 22, 2012"
3
.SH NAME
4
rulexdb_dataset_name \- get pointer to the dataset name string
5
.SH SYNOPSIS
6
.nf
7
.B #include <rulexdb.h>
8
.sp
9
.BI "const char *rulexdb_dataset_name(int " item_type );
10
.fi
11
.SH DESCRIPTION
12
The
13
.BR rulexdb_dataset_name ()
14
function gets pointer to the constant string containing internal name
15
of the dataset identified by
16
.I item_type
17
argument that may accept one of the following values:
18
.TP
19
.B RULEXDB_LEXBASE
20
The \fBImplicit\fP dictionary.
21
.TP
22
.B RULEXDB_EXCEPTION
23
The \fBExplicit\fP dictionary.
24
.TP
25
.B RULEXDB_LEXCLASS
26
The \fBClassifiers\fP ruleset.
27
.TP
28
.B RULEXDB_PREFIX
29
The \fBPrefix detectors\fP ruleset.
30
.TP
31
.B RULEXDB_RULE
32
The \fBGeneral\fP ruleset.
33
.TP
34
.B RULEXDB_CORRECTOR
35
The \fBCorrectors\fP ruleset.
36
.PP
37
Note that the dataset must be specified explicitly. The value
38
.B RULEXDB_DEFAULT
39
is not allowed here.
40
.SH "RETURN VALUE"
41
The
42
.BR rulexdb_dataset_name ()
43
function returns pointer to the dataset name string or NULL for
44
unknown dataset.
45
.SH SEE ALSO
46
.BR rulexdb_classify (3),
47
.BR rulexdb_close (3),
48
.BR rulexdb_discard_dictionary (3),
49
.BR rulexdb_discard_ruleset (3),
50
.BR rulexdb_fetch_rule (3),
51
.BR rulexdb_lexbase (3),
52
.BR rulexdb_load_ruleset (3),
53
.BR rulexdb_open (3),
54
.BR rulexdb_remove_item (3),
55
.BR rulexdb_remove_rule (3),
56
.BR rulexdb_remove_this_item (3),
57
.BR rulexdb_retrieve_item (3),
58
.BR rulexdb_search (3),
59
.BR rulexdb_seq (3),
60
.BR rulexdb_subscribe_item (3),
61
.BR rulexdb_subscribe_rule (3)
62
.SH AUTHOR
63
Igor B. Poretsky <poretsky@mlbox.ru>.
64