Transforms a string based on locale-specific information and stores the result.

#include <string.h>

size_t strxfrm (char *string1, const char *string2, size_t count);
size_t _strxfrm (char *string1, const char *string2, size_t count);

#include <wchar.h>

size_t wcsxfrm(wchar_t *string1, const wchar_t *string2, size_t count);

Parameters

string1

String to which transformed version of string2 is returned.

string2

String to transform.

count

Maximum number of characters to be placed in string1.

Remarks

The transformation is made using the information in the locale-specific LC_COLLATE macro.  _strxfrm is an alternate name for strxfrm.

The value of this expression is the size of the array needed to hold the transformation of the source string:

1 + strxfrm(NULL, string, 0);

The C libraries support the C locale only; thus strxfrm is equivalent to these commands:

strncpy (_string1, _string2, _count);
        return (strlen (_string2) );

After the transformation, a call to strcmp with the two transformed strings will yield identical results to a call to strcoll applied to the original two strings.

wcsxfrm is a wide-character version of strxfrm.

Return Values

The length of the transformed string, not counting the terminating null character.

Success.

If the return value is greater than or equal to count, the contents of string1 are unpredictable.

Failure.

Generic Text Routines

Requirements