.\" 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 "mchar_map_charset" 3m17n "15 Oct 2009" "" "Version 1.5.5" "" "The m17n Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
mchar_map_charset \- Call a function for all the characters in a specified charset. 


.SH SYNOPSIS
int
\fBmchar_map_charset\fP (\fBMSymbol\fP
\fIcharset_name\fP, void(*)(int
\fIfrom\fP, int
\fIto\fP, void *arg)
\fIfunc\fP, void *
\fIfunc_arg\fP)


.SH DESCRIPTION
Call a function for all the characters in a specified charset. 
.PP
The mcharset_map_chars() function calls
.ft B
func
.ft R
for all the characters in the charset named
.ft B
charset_name\fP.
.ft R
A call is done for a chunk of consecutive characters rather than character by character.
.PP
\fBfunc
.ft R
receives three arguments:
.ft B
from\fP,
.ft R
.ft B
to\fP,
.ft R
and
.ft B
arg\fP.
.ft R
.ft B
from
.ft R
and
.ft B
to
.ft R
specify the range of character codes in
.ft B
charset\fP.
.ft R
.ft B
arg
.ft R
is the same as
.ft B
func_arg\fP.
.ft R
.PP
.SH RETURN VALUE
.PP
.RS 4
If the operation was successful, mcharset_map_chars() returns 0. Otherwise, it returns \-1 and assigns an error code to the external variable
.ft B
merror_code\fP.
.ft R
.RE
.PP
.SH ERRORS
.PP
.RS 4
\fCMERROR_CHARSET
.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>.
