.\" ***** BEGIN LICENSE BLOCK *****
.\" Version: MPL 1.1/GPL 2.0/LGPL 2.1
.\"
.\" The contents of this file are subject to the Mozilla Public License Version
.\" 1.1 (the "License"); you may not use this file except in compliance with
.\" the License. You may obtain a copy of the License at
.\" http://www.mozilla.org/MPL/
.\"
.\" Software distributed under the License is distributed on an "AS IS" basis,
.\" WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
.\" for the specific language governing rights and limitations under the
.\" License.
.\"
.\" The Original Code is the Microline Widget Library, originally made available under the NPL by Neuron Data <http://www.neurondata.com>.
.\"
.\" The Initial Developer of the Original Code is
.\" Netscape Communications Corporation.
.\" Portions created by the Initial Developer are Copyright (C) 1998
.\" the Initial Developer. All Rights Reserved.
.\"
.\" Contributor(s):
.\"
.\" Alternatively, the contents of this file may be used under the terms of
.\" either the GNU General Public License Version 2 or later (the "GPL"), or
.\" the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
.\" in which case the provisions of the GPL or the LGPL are applicable instead
.\" of those above. If you wish to allow use of your version of this file only
.\" under the terms of either the GPL or the LGPL, and not to allow others to
.\" use your version of this file under the terms of the MPL, indicate your
.\" decision by deleting the provisions above and replace them with the notice
.\" and other provisions required by the GPL or the LGPL. If you do not delete
.\" the provisions above, a recipient may use your version of this file under
.\" the terms of any one of the MPL, the GPL or the LGPL.
.\"
.\" In addition, as a special exception to the GNU GPL, the copyright holders
.\" give permission to link the code of this program with the Motif and Open
.\" Motif libraries (or with modified versions of these that use the same
.\" license), and distribute linked combinations including the two. You
.\" must obey the GNU General Public License in all respects for all of
.\" the code used other than linking with Motif/Open Motif. If you modify
.\" this file, you may extend this exception to your version of the file,
.\" but you are not obligated to do so. If you do not wish to do so,
.\" delete this exception statement from your version.
.\"
.\" ***** END LICENSE BLOCK *****
.TH XmLCvtStringToUChar 3X "R1" "XML1" "XML"
.SH NAME
XmLCvtStringToUChar \- unsigned char resource converter
.SH SYNTAX
Boolean XmLCvtStringToUChar(\fIdpy\fP, \fIresname\fP, \fImap\fP, \
\fIfromVal\fP,  \fItoVal\fP)
.br
Display *\fIdpy\fP;
.br
char *\fIresname\fP;
.br
XmLStringToUCharMap *\fImap\fP;
.br
XrmValuePtr \fIfromVal\fP;
.br
XrmValuePtr \fItoVal\fP;
.LP
.SH ARGUMENTS
.IP \fIdpy\fP 1i
the display
.IP \fIresname\fP 1i
the resource name
.IP \fImap\fP 1i
the mappings of string to unsigned char
.IP \fIfromVal\fP 1i
the resource value from
.IP \fItoVal\fP 1i
the resource value to
.SH DESCRIPTION
This function can be used in a widget to perform resource conversion
from a string to an unsigned char.  This function should be called inside
a widgets resource converter where parameters \fIdpy\fP,
\fIfromVal\fP and \fItoVal\fP are available to be passed in.  The
\fIresname\fP parameter identifies the resource and the \fImap\fP
array is an array of mappings from strings to unsigned chars.  A
NULL string should be used in the last array element to terminate
the array.
.SH RETURN VALUE
True if conversion was successful and toVal is filled in and False if
conversion was unsuccessful.