1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123
|
.\" Copyright (C) 2001 Information-technology Promotion Agency (IPA)
.\" Copyright (C) 2001-2011
.\" National Institute of Advanced Industrial Science and Technology (AIST)
.\" This file is part of the m17n library documentation.
.\" Permission is granted to copy, distribute and/or modify this document
.\" under the terms of the GNU Free Documentation License, Version 1.2 or
.\" any later version published by the Free Software Foundation; with no
.\" Invariant Section, no Front-Cover Texts,
.\" and no Back-Cover Texts. A copy of the license is included in the
.\" appendix entitled "GNU Free Documentation License".
.TH "mdatabase_define" 3m17n "12 Jan 2011" "Version 1.6.2" "The m17n Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
mdatabase_define \- Define a data of the m17n database.
.SH SYNOPSIS
\fBMDatabase\fP*
\fBmdatabase_define\fP (\fBMSymbol\fP
\fItag0\fP, \fBMSymbol\fP
\fItag1\fP, \fBMSymbol\fP
\fItag2\fP, \fBMSymbol\fP
\fItag3\fP, void *(*)(\fBMSymbol\fP *, void *)
\fIloader\fP, void *
\fIextra_info\fP)
.SH DESCRIPTION
Define a data of the m17n database. The
.ft B
mdatabase_define()
.ft R
function defines a data that has tags
.ft B
tag0
.ft R
through
.ft B
tag3
.ft R
and additional information
.ft B
extra_info\fP.
.ft R
.PP
\fBloader
.ft R
is a pointer to a function that loads the data from the database. This function is called from the
.ft B
mdatabase_load()
.ft R
function with the two arguments
.ft B
tags
.ft R
and
.ft B
extra_info\fP.
.ft R
Here,
.ft B
tags
.ft R
is the array of
.ft B
tag0
.ft R
through
.ft B
tag3\fP.
.ft R
.PP
If
.ft B
loader
.ft R
is
.ft C
NULL\fP,
.ft R
the default loader of the m17n library is used. In this case,
.ft B
extra_info
.ft R
must be a string specifying a filename that contains the data.
.PP
.SH RETURN VALUE
.PP
.RS 4
If the operation was successful,
.ft B
mdatabase_define()
.ft R
returns a pointer to the defined data, which can be used as an argument to
.ft B
mdatabase_load()\fP.
.ft R
Otherwise, it returns
.ft C
NULL\fP.
.ft R
.RE
.PP
.SH "SEE ALSO"
.PP
.RS 4
\fBmdatabase_load()\fP,
.ft R
.ft B
mdatabase_define()
.ft R
.RE
.PP
.SH COPYRIGHT
Copyright (C) 2001 Information\-technology Promotion Agency (IPA)
.br
Copyright (C) 2001\-2011 National Institute of Advanced Industrial Science and Technology (AIST)
.br
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License
<http://www.gnu.org/licenses/fdl.html>.
|