summaryrefslogtreecommitdiff
path: root/usr/src/man/man3c/strtows.3c
diff options
context:
space:
mode:
authorRichard Lowe <richlowe@richlowe.net>2011-03-14 14:05:30 -0400
committerRichard Lowe <richlowe@richlowe.net>2011-03-14 14:05:30 -0400
commitc10c16dec587a0662068f6e2991c29ed3a9db943 (patch)
treef414286f4bba41d75683ed4fbbaa6bfa4bf7fabd /usr/src/man/man3c/strtows.3c
parent68caef18a23a498d9e3017b983562c0f4fd8ab23 (diff)
downloadillumos-joyent-c10c16dec587a0662068f6e2991c29ed3a9db943.tar.gz
243 system manual pages should live with the software
Reviewed by: garrett@nexenta.com Reviewed by: gwr@nexenta.com Reviewed by: trisk@opensolaris.org Approved by: gwr@nexenta.com --HG-- extra : rebase_source : 0c599d0bec0dc8865fbba67721a7a6cd6b1feefb
Diffstat (limited to 'usr/src/man/man3c/strtows.3c')
-rw-r--r--usr/src/man/man3c/strtows.3c51
1 files changed, 51 insertions, 0 deletions
diff --git a/usr/src/man/man3c/strtows.3c b/usr/src/man/man3c/strtows.3c
new file mode 100644
index 0000000000..e42a34ebcb
--- /dev/null
+++ b/usr/src/man/man3c/strtows.3c
@@ -0,0 +1,51 @@
+'\" te
+.\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved
+.\" 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.
+.\" 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.
+.\" 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]
+.TH strtows 3C "20 Dec 1996" "SunOS 5.11" "Standard C Library Functions"
+.SH NAME
+strtows, wstostr \- code conversion for Process Code and File Code
+.SH SYNOPSIS
+.LP
+.nf
+#include <widec.h>
+
+\fBwchar_t *\fR\fBstrtows\fR(\fBwchar_t *\fR\fIdst\fR, \fBchar *\fR\fIsrc\fR);
+.fi
+
+.LP
+.nf
+\fBchar *\fR\fBwstostr\fR(\fBchar *\fR\fIdst\fR, \fBwchar_t *\fR\fIsrc\fR);
+.fi
+
+.SH DESCRIPTION
+.sp
+.LP
+The \fBstrtows()\fR and \fBwstostr()\fR functions convert strings back and
+forth between File Code representation and Process Code.
+.sp
+.LP
+The \fBstrtows()\fR function takes a character string \fIsrc\fR, converts it to
+a Process Code string, terminated by a Process Code null, and places the result
+into \fIdst\fR.
+.sp
+.LP
+The \fBwstostr()\fR function takes the Process Code string pointed to by
+\fIsrc\fR, converts it to a character string, and places the result into
+\fIdst\fR.
+.SH RETURN VALUES
+.sp
+.LP
+The \fBstrtows()\fR function returns the Process Code string if it completes
+successfully. Otherwise, a null pointer will be returned and \fBerrno\fR will
+be set to \fBEILSEQ\fR.
+.sp
+.LP
+The \fBwstostr()\fR function returns the File Code string if it completes
+successfully. Otherwise, a null pointer will be returned and \fBerrno\fR will
+be set to \fBEILSEQ\fR.
+.SH SEE ALSO
+.sp
+.LP
+\fBwstring\fR(3C)