man3/strxfrm.3

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