strxfrm(3) [opendarwin man page]

STRXFRM(3)                                                   Linux Programmer's Manual                                                  STRXFRM(3)

NAME

       strxfrm - string transformation

SYNOPSIS

       #include <string.h>

       size_t strxfrm(char *dest, const char *src, size_t n);

DESCRIPTION

       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  trans-
       formed  string  are  placed  in  dest.   The  transformation is based on the program's current locale for category LC_COLLATE.  (See setlo-
       cale(3)).

RETURN VALUE

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

ATTRIBUTES

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

       +----------+---------------+----------------+
       |Interface | Attribute     | Value          |
       +----------+---------------+----------------+
       |strxfrm() | Thread safety | MT-Safe locale |
       +----------+---------------+----------------+
CONFORMING TO

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

SEE ALSO

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

COLOPHON

       This  page is part of release 4.15 of the Linux man-pages project.  A description of the project, information about reporting bugs, and the
       latest version of this page, can be found at https://www.kernel.org/doc/man-pages/.

GNU                                                                 2016-07-17                                                          STRXFRM(3)

STRXFRM(3P)						     POSIX Programmer's Manual						       STRXFRM(3P)

PROLOG

       This  manual page is part of the POSIX Programmer's Manual.  The Linux implementation of this interface may differ (consult the correspond-
       ing Linux manual page for details of Linux behavior), or the interface may not be implemented on Linux.

NAME

       strxfrm - string transformation

SYNOPSIS

       #include <string.h>

       size_t strxfrm(char *restrict s1, const char *restrict s2, size_t n);

DESCRIPTION

       The strxfrm() function shall transform the string pointed to by s2 and place the resulting string into the array  pointed  to  by  s1.  The
       transformation is such that if strcmp() is applied to two transformed strings, it shall return a value greater than, equal to, or less than
       0, corresponding to the result of strcoll() applied to the same two original strings. No more than n bytes are placed  into  the  resulting
       array  pointed  to  by  s1,  including  the  terminating null byte. If n is 0, s1 is permitted to be a null pointer. If copying takes place
       between objects that overlap, the behavior is undefined.

       The strxfrm() function shall not change the setting of errno if successful.

       Since no return value is reserved to indicate an error, an application wishing to check for error situations should set errno  to  0,  then
       call strxfrm(), then check errno.

RETURN VALUE

       Upon  successful  completion, strxfrm() shall return the length of the transformed string (not including the terminating null byte). If the
       value returned is n or more, the contents of the array pointed to by s1 are unspecified.

       On error, strxfrm() may set errno but no return value is reserved to indicate an error.

ERRORS

       The strxfrm() function may fail if:

       EINVAL The string pointed to by the s2 argument contains characters outside the domain of the collating sequence.

       The following sections are informative.

EXAMPLES

       None.

APPLICATION USAGE

       The transformation function is such that two transformed strings can be ordered by strcmp() as appropriate to collating	sequence  informa-
       tion in the program's locale (category LC_COLLATE ).

       The  fact  that when n is 0 s1 is permitted to be a null pointer is useful to determine the size of the s1 array prior to making the trans-
       formation.

RATIONALE

       None.

FUTURE DIRECTIONS

       None.

SEE ALSO

       strcmp(), strcoll(), the Base Definitions volume of IEEE Std 1003.1-2001, <string.h>

COPYRIGHT

       Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1, 2003 Edition, Standard for Information Technol-
       ogy -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2003 by the Institute of
       Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between this version and  the  original  IEEE
       and  The  Open Group Standard, the original IEEE and The Open Group Standard is the referee document. The original Standard can be obtained
       online at http://www.opengroup.org/unix/online.html .

IEEE
/The Open Group						       2003							       STRXFRM(3P)