nightly: remove unused BINARCHIVE
[unleashed.git] / share / man / man3c / wstring.3c
blob6b5d10d0749a44c7175c698d7a1b8554fe2679d3
1 '\" te
2 .\"  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 WSTRING 3C "Dec 29, 1996"
7 .SH NAME
8 wstring, wscasecmp, wsncasecmp, wsdup, wscol \- Process Code string operations
9 .SH SYNOPSIS
10 .LP
11 .nf
12 #include <widec.h>
14 \fBint\fR \fBwscasecmp\fR(\fBconst wchar_t *\fR\fIs1\fR, \fBconst wchar_t *\fR\fIs2\fR);
15 .fi
17 .LP
18 .nf
19 \fBint\fR \fBwsncasecmp\fR(\fBconst wchar_t *\fR\fIs1\fR, \fBconst wchar_t *\fR\fIs2\fR, \fBint\fR \fIn\fR);
20 .fi
22 .LP
23 .nf
24 \fBwchar_t *\fR\fBwsdup\fR(\fBconst wchar_t *\fR\fIs\fR);
25 .fi
27 .LP
28 .nf
29 \fBint\fR \fBwscol\fR(\fBconst wchar_t *\fR\fIs\fR);
30 .fi
32 .SH DESCRIPTION
33 .sp
34 .LP
35 These functions operate on Process Code strings terminated by \fBwchar_t\fR
36 null characters.  During appending or copying, these routines do not check for
37 an overflow condition of the receiving string. In the following, \fIs\fR,
38 \fIs1\fR, and \fIs2\fR point to Process Code strings terminated by a
39 \fBwchar_t\fR null.
40 .SS "wscasecmp(\|), wsncasecmp(\|)"
41 .sp
42 .LP
43 The \fBwscasecmp()\fR function compares its arguments, ignoring case, and
44 returns an integer greater than, equal to, or less than 0, depending upon
45 whether \fIs1\fR is lexicographically greater than, equal to, or less than
46 \fIs2\fR. It makes the same comparison but compares at most \fIn\fR Process
47 Code characters. The four Extended Unix Code (EUC) codesets are ordered from
48 lowest to highest as 0, 2, 3, 1 when characters from different codesets are
49 compared.
50 .SS "wsdup(\|)"
51 .sp
52 .LP
53 The \fBwsdup()\fR function returns a pointer to a new Process Code string,
54 which is a duplicate of the string pointed to by \fIs\fR. The space for the new
55 string is obtained using \fBmalloc\fR(3C). If the new string cannot be created,
56 a null pointer is returned.
57 .SS "wscol(\|)"
58 .sp
59 .LP
60 The \fBwscol()\fR function returns the screen display width (in columns) of the
61 Process Code string \fIs\fR.
62 .SH ATTRIBUTES
63 .sp
64 .LP
65 See \fBattributes\fR(5) for descriptions of the following attributes:
66 .sp
68 .sp
69 .TS
70 box;
71 c | c
72 l | l .
73 ATTRIBUTE TYPE  ATTRIBUTE VALUE
75 MT-Level        MT-Safe
76 .TE
78 .SH SEE ALSO
79 .sp
80 .LP
81 \fBmalloc\fR(3C), \fBstring\fR(3C), \fBwcstring\fR(3C), \fBattributes\fR(5)