Imported upstream version 1.5
[manpages-zh.git] / raw / man3 / strxfrm.3
blob916412c70c74818ef73f5c0aec6b0b34793c4e9c
1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
2 .\"
3 .\" Permission is granted to make and distribute verbatim copies of this
4 .\" manual provided the copyright notice and this permission notice are
5 .\" preserved on all copies.
6 .\"
7 .\" Permission is granted to copy and distribute modified versions of this
8 .\" manual under the conditions for verbatim copying, provided that the
9 .\" entire resulting derived work is distributed under the terms of a
10 .\" permission notice identical to this one
11 .\" 
12 .\" Since the Linux kernel and libraries are constantly changing, this
13 .\" manual page may be incorrect or out-of-date.  The author(s) assume no
14 .\" responsibility for errors or omissions, or for damages resulting from
15 .\" the use of the information contained herein.  The author(s) may not
16 .\" have taken the same level of care in the production of this manual,
17 .\" which is licensed free of charge, as they might when working
18 .\" professionally.
19 .\" 
20 .\" Formatted or processed versions of this manual, if unaccompanied by
21 .\" the source, must acknowledge the copyright and authors of this work.
22 .\"
23 .\" References consulted:
24 .\"     Linux libc source code
25 .\"     Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
26 .\"     386BSD man pages
27 .\" Modified Sun Jul 25 10:41:28 1993 by Rik Faith (faith@cs.unc.edu)
28 .TH STRXFRM 3  1993-04-12 "GNU" "Linux Programmer's Manual"
29 .SH NAME
30 strxfrm \- string transformation
31 .SH SYNOPSIS
32 .nf
33 .B #include <string.h>
34 .sp
35 .BI "size_t strxfrm(char *" dest ", const char *" src ", size_t " n );
36 .fi
37 .SH DESCRIPTION
38 The \fBstrxfrm()\fP function transforms the \fIsrc\fP string into a
39 form such that the result of \fBstrcmp()\fP on two strings that have
40 been transformed with \fBstrxfrm()\fP is the same as the result of
41 \fBstrcoll()\fP on the two strings before their transformation.  The
42 first \fIn\fP characters of the transformed string are placed in
43 \fIdest\fP.  The transformation is based on the program's current
44 locale for category \fILC_COLLATE\fP.  (See \fBsetlocale\fP(3)).
45 .SH "RETURN VALUE"
46 The \fBstrxfrm()\fP function returns the number of bytes required to
47 store the transformed string in \fIdest\fP excluding the terminating
48 `\\0' character.  If the value returned is \fIn\fP or more, the
49 contents of \fIdest\fP are indeterminate.
50 .SH "CONFORMING TO"
51 SVID 3, BSD 4.3, ISO 9899
52 .SH NOTES
53 In the \fI"POSIX"\fP or \fI"C"\fP locales \fBstrxfrm()\fP is equivalent to
54 copying the string with \fBstrncpy()\fP.
55 .SH "SEE ALSO"
56 .BR bcmp (3),
57 .BR memcmp (3),
58 .BR strcasecmp (3),
59 .BR strcmp (3),
60 .BR strcoll (3),
61 .BR setlocale (3)