original/man3/strxfrm.3

   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  2010-09-20 "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
  39 .BR strxfrm ()
  40 function transforms the \fIsrc\fP string into a
  41 form such that the result of
  42 .BR strcmp (3)
  43 on two strings that have
  44 been transformed with
  45 .BR strxfrm ()
  46 is the same as the result of
  47 .BR strcoll (3)
  48 on the two strings before their transformation.
  49 The first \fIn\fP characters of the transformed string are placed in
  50 \fIdest\fP.
  51 The transformation is based on the program's current
  52 locale for category \fBLC_COLLATE\fP.  (See
  53 .BR setlocale (3)).
  54 .SH "RETURN VALUE"
  55 The
  56 .BR strxfrm ()
  57 function returns the number of bytes required to
  58 store the transformed string in \fIdest\fP excluding the
  59 terminating \(aq\\0\(aq character.
  60 If the value returned is \fIn\fP or more, the
  61 contents of \fIdest\fP are indeterminate.
  62 .SH "CONFORMING TO"
  63 SVr4, 4.3BSD, C89, C99.
  64 .SH NOTES
  65 In the \fI"POSIX"\fP or \fI"C"\fP locales
  66 .BR strxfrm ()
  67 is equivalent to
  68 copying the string with
  69 .BR strncpy (3).
  70 .SH "SEE ALSO"
  71 .BR bcmp (3),
  72 .BR memcmp (3),
  73 .BR setlocale (3),
  74 .BR strcasecmp (3),
  75 .BR strcmp (3),
  76 .BR strcoll (3),
  77 .BR string (3)