strxfrm(3) — Linux manual page

strxfrm(3)              Library Functions Manual              strxfrm(3)

NAME         top

       strxfrm - string transformation

LIBRARY         top

       Standard C library (libc, -lc)

SYNOPSIS         top

       #include <string.h>

       size_t strxfrm(char dest[restrict .n], const char src[restrict .n],
                      size_t n);

DESCRIPTION         top

       The strxfrm() function transforms the src string into a form such
       that the result of strcmp(3) on two strings that have been
       transformed with strxfrm() is the same as the result of
       strcoll(3) on the two strings before their transformation.  The
       first n bytes of the transformed string are placed in dest.  The
       transformation is based on the program's current locale for
       category LC_COLLATE.  (See setlocale(3)).

RETURN VALUE         top

       The strxfrm() function returns the number of bytes required to
       store the transformed string in dest excluding the terminating
       null byte ('\0').  If the value returned is n or more, the
       contents of dest are indeterminate.

ATTRIBUTES         top

       For an explanation of the terms used in this section, see
       attributes(7).

       ┌───────────────────────────────┬───────────────┬────────────────┐
       │Interface                      │ Attribute     │ Value          │
       ├───────────────────────────────┼───────────────┼────────────────┤
       │strxfrm()                      │ Thread safety │ MT-Safe locale │
       └───────────────────────────────┴───────────────┴────────────────┘

STANDARDS         top

       C11, POSIX.1-2008.

HISTORY         top

       POSIX.1-2001, C89, SVr4, 4.3BSD.

SEE ALSO         top

       memcmp(3), setlocale(3), strcasecmp(3), strcmp(3), strcoll(3),
       string(3)

Linux man-pages 6.04           2023-03-30                     strxfrm(3)

Pages that refer to this page: setlocale(3),  strcoll(3),  string(3),  locale(7)

HTML rendering created 2023-06-24 by Michael Kerrisk, author of The Linux Programming Interface. For details of in-depth Linux/UNIX system programming training courses that I teach, look here. Hosting by jambit GmbH.