9103 opengroup acknowledgement should be properly formatted in man pages
[unleashed.git] / usr / src / man / man3c / strtows.3c
blob90e6577f1d08a6c4cd5b2844adf6d6bfd3bd25c1
1 '\" te
2 .\"  Portions Copyright (c) 1996, Sun Microsystems, Inc.  All Rights Reserved
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH STRTOWS 3C "Dec 20, 1996"
7 .SH NAME
8 strtows, wstostr \- code conversion for Process Code and File Code
9 .SH SYNOPSIS
10 .LP
11 .nf
12 #include <widec.h>
14 \fBwchar_t *\fR\fBstrtows\fR(\fBwchar_t *\fR\fIdst\fR, \fBchar *\fR\fIsrc\fR);
15 .fi
17 .LP
18 .nf
19 \fBchar *\fR\fBwstostr\fR(\fBchar *\fR\fIdst\fR, \fBwchar_t *\fR\fIsrc\fR);
20 .fi
22 .SH DESCRIPTION
23 .sp
24 .LP
25 The \fBstrtows()\fR and \fBwstostr()\fR functions convert strings back and
26 forth between File Code representation and Process Code.
27 .sp
28 .LP
29 The \fBstrtows()\fR function takes a character string \fIsrc\fR, converts it to
30 a Process Code string, terminated by a Process Code null, and places the result
31 into \fIdst\fR.
32 .sp
33 .LP
34 The \fBwstostr()\fR function takes the Process Code string pointed to by
35 \fIsrc\fR, converts it to a character string, and places the result into
36 \fIdst\fR.
37 .SH RETURN VALUES
38 .sp
39 .LP
40 The \fBstrtows()\fR function returns the Process Code string if it completes
41 successfully. Otherwise, a null pointer will be returned and \fBerrno\fR will
42 be set to \fBEILSEQ\fR.
43 .sp
44 .LP
45 The \fBwstostr()\fR function returns the File Code string if it completes
46 successfully. Otherwise, a null pointer will be returned and \fBerrno\fR will
47 be set to \fBEILSEQ\fR.
48 .SH SEE ALSO
49 .sp
50 .LP
51 \fBwstring\fR(3C)