.\" 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 "msymbol" 3m17n "15 Oct 2009" "" "Version 1.5.5" "" "The m17n Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
msymbol \- Get a symbol. 


.SH SYNOPSIS
\fBMSymbol\fP
\fBmsymbol\fP (const char *
\fIname\fP)


.SH DESCRIPTION
Get a symbol. 
.PP
The
.ft B
msymbol()
.ft R
function returns the canonical symbol whose name is
.ft B
name\fP.
.ft R
If there is none, one is created. The created one is not a managing key.
.PP
Symbols whose name starts by two spaces are reserved by the m17n library, and are used by the library only internally.
.PP
.SH RETURN VALUE
.PP
.RS 4
This function returns the found or created symbol.
.RE
.PP
.SH ERRORS
.PP
.RS 4
This function never fails.
.RE
.PP
.SH "SEE ALSO"
.PP
.RS 4
\fBmsymbol_as_managing_key()\fP,
.ft R
.ft B
msymbol_name()\fP,
.ft R
.ft B
msymbol_exist()
.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>.
