.\" 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_load" 3m17n "15 Oct 2009" "" "Version 1.5.5" "" "The m17n Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
mdatabase_load \- Load a data from the database. 


.SH SYNOPSIS
void*
\fBmdatabase_load\fP (\fBMDatabase\fP *
\fImdb\fP)


.SH DESCRIPTION
Load a data from the database. 
.PP
The
.ft B
mdatabase_load()
.ft R
function loads a data specified in
.ft B
mdb
.ft R
and returns the contents. The type of contents depends on the type of the data.
.PP
If the data is of the
.ft I
plist
.ft R
.ft I
type\fP,
.ft R
this function returns a pointer to
.ft I
plist\fP.
.ft R
.PP
If the database is of the
.ft I
chartable
.ft R
.ft I
type\fP,
.ft R
it returns a chartable. The default value of the chartable is set according to the second tag of the data as below:
.PP
.PD 0
.IP "\(bu" 2
If the tag is
.ft B
Msymbol\fP,
.ft R
the default value is
.ft B
Mnil\fP.
.ft R
.IP "\(bu" 2
If the tag is
.ft B
Minteger\fP,
.ft R
the default value is \-1. 
.IP "\(bu" 2
Otherwise, the default value is
.ft C
NULL\fP.
.ft R
.PP
If the data is of the
.ft I
charset
.ft R
.ft I
type\fP,
.ft R
it returns a plist of length 2 (keys are both
.ft B
Mt\fP). The value of the first element is an array of integers that maps code points to the corresponding character codes. The value of the second element is a chartable of integers that does the reverse mapping. The charset must be defined in advance.
.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>.
