rulex

1
.\"                                      Hey, EMACS: -*- nroff -*-
2
.TH RULEXDB_SEQ 3 "February 20, 2012"
3
.SH NAME
4
rulexdb_seq \- sequential retrieving dictionary items from the rulex database
5
.SH SYNOPSIS
6
.nf
7
.B #include <rulexdb.h>
8
.sp
9
.BI "int rulexdb_search(RULEXDB *" rulexdb ", char *" key \
10
", char *" value ", int " item_type ", int " mode );
11
.fi
12
.SH DESCRIPTION
13
The
14
.BR rulexdb_seq ()
15
function sequentially fetches lexical records one by one. It's
16
operations are not disturbed by the key-based search.
17
.PP
18
The argument
19
.I rulexdb
20
references the rulex database.
21
.PP
22
The arguments
23
.I key
24
and
25
.I value
26
must point to the buffers with enough space for retrieved data.
27
.PP
28
The argument
29
.I item_type
30
specifies the dictionary dataset from which data will be retrieved. It
31
may accept one of the following values:
32
.TP
33
.B RULEXDB_LEXBASE
34
Extract data from the \fBImplicit\fP dictionary.
35
.TP
36
.B RULEXDB_EXCEPTION
37
Extract data from the \fBExplicit\fP dictionary.
38
.PP
39
Note that the data type must be specified explicitly. The value
40
.B RULEXDB_DEFAULT
41
is not allowed here.
42
.PP
43
When fetching data from the \fBExplicit\fP dictionary the correction
44
rules will be applied. To prevent this feature you can specify
45
.B RULEXDB_EXCEPTION_RAW
46
instead of
47
.BR RULEXDB_EXCEPTION .
48
.PP
49
The
50
.I mode
51
argument specifies direction of the dictionary scanning. Allowed
52
 values are:
53
.BR DB_FIRST ", " DB_NEXT ", " DB_PREV ", or " DB_LAST
54
as defined for the underlying database library.
55
.SH "RETURN VALUE"
56
The
57
.BR rulexdb_seq ()
58
function returns
59
.B RULEXDB_SUCCESS
60
which is zero upon success, positive value
61
.B RULEXDB_SPECIAL
62
when no more records can be fetched, or negative error code if
63
something is wrong.
64
.SH ERRORS
65
.TP
66
.B RULEXDB_FAILURE
67
Referenced database has not been opened, internal data structures are
68
corrupted or some other general failure has occurred.
69
.TP
70
.B RULEXDB_EMALLOC
71
Internal memory allocation error.
72
.TP
73
.B RULEXDB_EPARM
74
Invalid parameters are specified.
75
.SH SEE ALSO
76
.BR rulexdb_classify (3),
77
.BR rulexdb_close (3),
78
.BR rulexdb_dataset_name (3),
79
.BR rulexdb_discard_dictionary (3),
80
.BR rulexdb_discard_ruleset (3),
81
.BR rulexdb_fetch_rule (3),
82
.BR rulexdb_lexbase (3),
83
.BR rulexdb_load_ruleset (3),
84
.BR rulexdb_open (3),
85
.BR rulexdb_remove_item (3),
86
.BR rulexdb_remove_rule (3),
87
.BR rulexdb_remove_this_item (3),
88
.BR rulexdb_retrieve_item (3),
89
.BR rulexdb_search (3),
90
.BR rulexdb_subscribe_item (3),
91
.BR rulexdb_subscribe_rule (3)
92
.SH AUTHOR
93
Igor B. Poretsky <poretsky@mlbox.ru>.
94