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  2021-03-22 "GNU" "Linux Programmer's Manual"
  31 .SH NAME
  32 strxfrm \- string transformation
  33 .SH SYNOPSIS
  34 .nf
  35 .B #include <string.h>
  36 .PP
  37 .BI "size_t strxfrm(char *restrict " dest ", const char *restrict " src ,
  38 .BI "               size_t " n );
  39 .fi
  40 .SH DESCRIPTION
  41 The
  42 .BR strxfrm ()
  43 function transforms the
  44 .I src
  45 string into a
  46 form such that the result of
  47 .BR strcmp (3)
  48 on two strings that have
  49 been transformed with
  50 .BR strxfrm ()
  51 is the same as the result of
  52 .BR strcoll (3)
  53 on the two strings before their transformation.
  54 The first
  55 .I n
  56 bytes of the transformed string are placed in
  57 .IR dest .
  58 The transformation is based on the program's current
  59 locale for category
  60 .BR LC_COLLATE .
  61 (See
  62 .BR setlocale (3)).
  63 .SH RETURN VALUE
  64 The
  65 .BR strxfrm ()
  66 function returns the number of bytes required to
  67 store the transformed string in
  68 .I dest
  69 excluding the
  70 terminating null byte (\(aq\e0\(aq).
  71 If the value returned is
  72 .I n
  73 or more, the
  74 contents of
  75 .I dest
  76 are indeterminate.
  77 .SH ATTRIBUTES
  78 For an explanation of the terms used in this section, see
  79 .BR attributes (7).
  80 .ad l
  81 .nh
  82 .TS
  83 allbox;
  84 lbx lb lb
  85 l l l.
  86 Interface       Attribute       Value
  87 T{
  88 .BR strxfrm ()
  89 T}      Thread safety   MT-Safe locale
  90 .TE
  91 .hy
  92 .ad
  93 .sp 1
  94 .SH CONFORMING TO
  95 POSIX.1-2001, POSIX.1-2008, C89, C99, SVr4, 4.3BSD.
  96 .SH SEE ALSO
  97 .BR bcmp (3),
  98 .BR memcmp (3),
  99 .BR setlocale (3),
 100 .BR strcasecmp (3),
 101 .BR strcmp (3),
 102 .BR strcoll (3),
 103 .BR string (3)