Print this page
Garrett's man page edits.
| Split |
Close |
| Expand all |
| Collapse all |
--- old/usr/src/man/man3c/strxfrm.3c
+++ new/usr/src/man/man3c/strxfrm.3c
1 1 '\" te
2 +.\" Copyright 2014 Garrett D'Amore <garrett@damore.org>
2 3 .\" Copyright 1989 AT&T. Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved. Portions Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
3 4 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
4 5 .\" http://www.opengroup.org/bookstore/.
5 6 .\" The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions and the original IEEE and The Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained online at http://www.opengroup.org/unix/online.html.
6 7 .\" This notice shall appear on any product containing this material.
7 8 .\" 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.
8 9 .\" 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.
9 10 .\" 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]
10 -.TH STRXFRM 3C "Dec 10, 2003"
11 +.TH STRXFRM 3C "Jun 21, 2014"
11 12 .SH NAME
12 13 strxfrm, strxfrm_l \- string transformation
13 14 .SH SYNOPSIS
14 15 .LP
15 16 .nf
16 17 #include <string.h>
17 18
18 19 \fBsize_t\fR \fBstrxfrm\fR(\fBchar *restrict\fR \fIs1\fR, \fBconst char *restrict\fR \fIs2\fR, \fBsize_t\fR \fIn\fR);
19 -\fBsize_t\fR \fBstrxfrm_l\fR(\fBchar *restrict\fR \fIs1\fR, \fBconst char *restrict\fR \fIs2\fR, \fBsize_t\fR \fIn\fR, \fBlocale_t\fR \fIloc\fR);
20 20 .fi
21 -
21 +.LP
22 +.nf
23 +\fBsize_t\fR \fBstrxfrm_l\fR(\fBchar *restrict\fR \fIs1\fR, \fBconst char *restrict\fR \fIs2\fR, \fBsize_t\fR \fIn\fR,
24 + \fBlocale_t\fR \fIloc\fR);
25 +.fi
22 26 .SH DESCRIPTION
23 -.sp
24 27 .LP
25 28 The \fBstrxfrm()\fR function transforms the string pointed to by \fIs2\fR and
26 29 places the resulting string into the array pointed to by \fIs1\fR. The
27 30 transformation is such that if \fBstrcmp\fR(3C) is applied to two transformed
28 31 strings, it returns a value greater than, equal to or less than \fB0\fR,
29 32 corresponding to the result of \fBstrcoll\fR(3C) applied to the same two
30 33 original strings. No more than \fIn\fR bytes are placed into the resulting
31 34 array pointed to by \fIs1\fR, including the terminating null byte. If \fIn\fR
32 35 is \fB0\fR, \fIs1\fR is permitted to be a null pointer. If copying takes place
33 36 between objects that overlap, the behavior is undefined.
34 -.sp
35 37 .LP
36 38 The \fBstrxfrm()\fR function does not change the setting of \fBerrno\fR if
37 39 successful.
38 -.sp
39 40 .LP
40 41 Since no return value is reserved to indicate an error, an application wishing
41 42 to check for error situations should set \fBerrno\fR to 0, then call
42 43 \fBstrxfrm()\fR, then check \fBerrno\fR.
43 -.sp
44 44 .LP
45 45 The \fBstrxfrm_l()\fR functions behaves identically to the function
46 -\fBstrxfrm()\fR, except instead of operating in the current environment it
47 -operates in the environment specified by the argument \fIloc\fR.
46 +\fBstrxfrm()\fR, except instead of operating in the current locale it
47 +operates in the locale specified by the argument \fIloc\fR.
48 48 .SH RETURN VALUES
49 -.sp
50 49 .LP
51 50 Upon successful completion, \fBstrxfrm()\fR returns the length of the
52 51 transformed string (not including the terminating null byte). If the value
53 52 returned is \fIn\fR or more, the contents of the array pointed to by \fIs1\fR
54 53 are indeterminate.
55 -.sp
56 54 .LP
57 55 On error, \fBstrxfrm()\fR may set \fBerrno\fR but no return value is reserved
58 56 to indicate the error.
59 57 .SH USAGE
60 -.sp
61 58 .LP
62 59 The transformation function is such that two transformed strings can be ordered
63 60 by \fBstrcmp\fR(3C) as appropriate to collating sequence information in the
64 -program's locale (category \fBLC_COLLATE\fR).
65 -.sp
61 +locale (category \fBLC_COLLATE\fR).
66 62 .LP
67 63 The fact that when \fIn\fR is \fB0\fR, \fIs1\fR is permitted to be a null
68 64 pointer, is useful to determine the size of the \fIs1\fR array prior to making
69 65 the transformation.
70 66 .SH EXAMPLES
71 67 .LP
72 68 \fBExample 1 \fRA sample of using the \fBstrxfm()\fR function.
73 -.sp
74 69 .LP
75 70 The value of the following expression is the size of the array needed to hold
76 71 the transformation of the string pointed to by \fIs\fR.
77 72
78 73 .sp
79 74 .in +2
80 75 .nf
81 76 1 + strxfrm(NULL, s, 0);
82 77 .fi
83 78 .in -2
84 79
85 80 .SH FILES
86 -.sp
87 -.ne 2
88 -.na
89 -\fB\fB/usr/lib/locale/\fIlocale\fR/\fIlocale\fR.so.*\fR\fR
90 -.ad
91 -.sp .6
92 -.RS 4n
93 -\fBLC_COLLATE\fR database for \fIlocale\fR
94 -.RE
95 -
81 +.IP \fB/usr/lib/locale/\fR\fIlocale\fR\fB/LC_COLLATE/*
82 +collation database for \fIlocale\fR
96 83 .SH ATTRIBUTES
97 -.sp
98 84 .LP
99 85 See \fBattributes\fR(5) for descriptions of the following attributes:
100 -.sp
101 -
102 -.sp
103 86 .TS
104 87 box;
105 88 c | c
106 89 l | l .
107 90 ATTRIBUTE TYPE ATTRIBUTE VALUE
108 91 _
109 92 CSI Enabled
110 93 _
111 94 Interface Stability Standard
112 95 _
113 -MT-Level MT-Safe with exceptions
96 +MT-Level MT-Safe
114 97 .TE
115 98
116 -.sp
117 -.LP
118 -The \fBstrxfrm()\fR function can be used safely in a multithreaded application,
119 -as long as \fBsetlocale\fR(3C) is not being called to change the locale.
120 99 .SH SEE ALSO
121 -.sp
122 100 .LP
123 -\fBlocaledef\fR(1), \fBsetlocale\fR(3C), \fBstrcmp\fR(3C), \fBstrcoll\fR(3C),
101 +\fBlocaledef\fR(1), \fBnewlocale\fR(3C), \fBsetlocale\fR(3C), \fBstrcmp\fR(3C),
102 +\fBstrcoll\fR(3C), \fBuselocale\fR(3C),
124 103 \fBwscoll\fR(3C), \fBattributes\fR(5), \fBenviron\fR(5), \fBstandards\fR(5)
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX