.\" Copyright (C) 2001 Information-technology Promotion Agency (IPA)
.\" Copyright (C) 2001-2009
.\"   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 "15 Oct 2009" "" "Version 1.5.5" "" "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. 
.PP
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\-2009 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>.
