strxfrm(3) [v7 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(3C)						   Standard C Library Functions 					       strxfrm(3C)

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 transforms the string pointed to by s2 and places the resulting string into the array pointed to by s1. The trans-
       formation is such that if strcmp(3C) is applied to two transformed strings, it returns a value greater than, equal to or less than 0,  cor-
       responding  to the result of strcoll(3C) 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 does 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 VALUES

       Upon successful completion, strxfrm() returns 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 indeterminate.

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

USAGE

       The transformation function is such that two transformed strings can be ordered by strcmp(3C) 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.

EXAMPLES

       Example 1 A sample of using the strxfm() function.

       The value of the following expression is the size of the array needed to hold the transformation of the string pointed to by s.

	 1 + strxfrm(NULL, s, 0);

FILES

       /usr/lib/locale/locale/locale.so.*

	   LC_COLLATE database for locale

ATTRIBUTES

       See attributes(5) for descriptions of the following attributes:

       +-----------------------------+-----------------------------+
       |      ATTRIBUTE TYPE	     |	    ATTRIBUTE VALUE	   |
       +-----------------------------+-----------------------------+
       |CSI			     |Enabled			   |
       +-----------------------------+-----------------------------+
       |Interface Stability	     |Standard			   |
       +-----------------------------+-----------------------------+
       |MT-Level		     |MT-Safe with exceptions	   |
       +-----------------------------+-----------------------------+

       The  strxfrm()  function  can  be  used	safely	in a multithreaded application, as long as setlocale(3C) is not being called to change the
       locale.

SEE ALSO

       localedef(1), setlocale(3C), strcmp(3C), strcoll(3C), wscoll(3C), attributes(5), environ(5), standards(5)

SunOS 5.11							    10 Dec 2003 						       strxfrm(3C)