UNIXworkcode

1 .\" ***** BEGIN LICENSE BLOCK ***** 2 .\" Version: MPL 1.1/GPL 2.0/LGPL 2.1 3 .\" 4 .\" The contents of this file are subject to the Mozilla Public License Version 5 .\" 1.1 (the "License"); you may not use this file except in compliance with 6 .\" the License. You may obtain a copy of the License at 7 .\" http://www.mozilla.org/MPL/ 8 .\" 9 .\" Software distributed under the License is distributed on an "AS IS" basis, 10 .\" WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License 11 .\" for the specific language governing rights and limitations under the 12 .\" License. 13 .\" 14 .\" The Original Code is the Microline Widget Library, originally made available under the NPL by Neuron Data <http://www.neurondata.com>. 15 .\" 16 .\" The Initial Developer of the Original Code is 17 .\" Netscape Communications Corporation. 18 .\" Portions created by the Initial Developer are Copyright (C) 1998 19 .\" the Initial Developer. All Rights Reserved. 20 .\" 21 .\" Contributor(s): 22 .\" 23 .\" Alternatively, the contents of this file may be used under the terms of 24 .\" either the GNU General Public License Version 2 or later (the "GPL"), or 25 .\" the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), 26 .\" in which case the provisions of the GPL or the LGPL are applicable instead 27 .\" of those above. If you wish to allow use of your version of this file only 28 .\" under the terms of either the GPL or the LGPL, and not to allow others to 29 .\" use your version of this file under the terms of the MPL, indicate your 30 .\" decision by deleting the provisions above and replace them with the notice 31 .\" and other provisions required by the GPL or the LGPL. If you do not delete 32 .\" the provisions above, a recipient may use your version of this file under 33 .\" the terms of any one of the MPL, the GPL or the LGPL. 34 .\" 35 .\" In addition, as a special exception to the GNU GPL, the copyright holders 36 .\" give permission to link the code of this program with the Motif and Open 37 .\" Motif libraries (or with modified versions of these that use the same 38 .\" license), and distribute linked combinations including the two. You 39 .\" must obey the GNU General Public License in all respects for all of 40 .\" the code used other than linking with Motif/Open Motif. If you modify 41 .\" this file, you may extend this exception to your version of the file, 42 .\" but you are not obligated to do so. If you do not wish to do so, 43 .\" delete this exception statement from your version. 44 .\" 45 .\" ***** END LICENSE BLOCK ***** 46 .TH XmLCvtStringToUChar 3X "R1" "XML1" "XML" 47 .SH NAME 48 XmLCvtStringToUChar \- unsigned char resource converter 49 .SH SYNTAX 50 Boolean XmLCvtStringToUChar(\fIdpy\fP, \fIresname\fP, \fImap\fP, \ 51 \fIfromVal\fP, \fItoVal\fP) 52 .br 53 Display *\fIdpy\fP; 54 .br 55 char *\fIresname\fP; 56 .br 57 XmLStringToUCharMap *\fImap\fP; 58 .br 59 XrmValuePtr \fIfromVal\fP; 60 .br 61 XrmValuePtr \fItoVal\fP; 62 .LP 63 .SH ARGUMENTS 64 .IP \fIdpy\fP 1i 65 the display 66 .IP \fIresname\fP 1i 67 the resource name 68 .IP \fImap\fP 1i 69 the mappings of string to unsigned char 70 .IP \fIfromVal\fP 1i 71 the resource value from 72 .IP \fItoVal\fP 1i 73 the resource value to 74 .SH DESCRIPTION 75 This function can be used in a widget to perform resource conversion 76 from a string to an unsigned char. This function should be called inside 77 a widgets resource converter where parameters \fIdpy\fP, 78 \fIfromVal\fP and \fItoVal\fP are available to be passed in. The 79 \fIresname\fP parameter identifies the resource and the \fImap\fP 80 array is an array of mappings from strings to unsigned chars. A 81 NULL string should be used in the last array element to terminate 82 the array. 83 .SH RETURN VALUE 84 True if conversion was successful and toVal is filled in and False if 85 conversion was unsuccessful. 86