Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

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)

Check Out this Related Man Page

strxfrm(3)						     Library Functions Manual							strxfrm(3)

NAME
strxfrm - Transforms string for collation in current locale LIBRARY
Standard C Library (libc.so, libc.a) SYNOPSIS
#include <string.h> size_t strxfrm( char *s1, const char *s2, size_t n); STANDARDS
Interfaces documented on this reference page conform to industry standards as follows: strxfrm(): XPG4, XPG4-UNIX Refer to the standards(5) reference page for more information about industry standards and associated tags. PARAMETERS
Specifies the destination string. Specifies the string to be transformed. Specifies the maximum number of bytes to store in the trans- formed string. DESCRIPTION
The strxfrm() function transforms the string pointed to by the s2 parameter into an internal form suitable for collation and places the result in the address specified by s1. This transformation is performed as appropriate to the LC_COLLATE category of the current locale. When the strcmp() function is applied to two transformed strings, a value greater than, equal to, or less than 0 (zero) is returned. The returned value corresponds to the same value that is returned when the strcoll() function is applied to the same two original transformed strings. The transformed string can be longer than the original string. No more than n characters are placed in the location pointed to by the s1 parameter, including the terminating null character. When n is 0 (zero), the s1 parameter can be a null pointer. When operating on overlapping strings, the behavior of this function is unreliable. NOTES
If you are doing multiple comparisons using the same set of text strings, the strxfrm() transformation function in conjunction with the strcmp() function may be more efficient than using the strcoll() collation function because the string is transformed based on the locale tables only once. However, the transformation function must convert all characters in the string for each level of a multi-level colla- tion. In comparison, the collation function stops comparing characters at the first inequality. These efficiency tradeoffs make the most efficient method for a specific application dependent on both the number of repeated comparisons for each string and the contents of each string. RETURN VALUES
Upon successful completion, the strxfrm() function returns the number of bytes required to store the transformed string (not including the terminating null byte). If this is greater than or equal to the value of the n parameter, which specifies the maximum number of bytes that can be stored in s1, the contents of s1 are indeterminate. ERRORS
If the following condition occurs, the strxfrm() function sets errno to the corresponding value. The s2 parameter contains codes outside the domain of the collating sequence defined by the current locale. RELATED INFORMATION
Functions: setlocale(3), strcoll(3), string(3)/strcmp(3), wcsxfrm(3) Standards: standards(5) delim off strxfrm(3)
Man Page