Mac Developer Library Developer
Search

 

This manual page is part of Xcode Tools version 5.0

To obtain these tools:

If you are running a version of Xcode Tools other than 5.0, view the documentation locally:

  • In Xcode

  • In Terminal, using the man(1) command

Reading manual pages

Manual pages are intended as a quick reference for people who already understand a technology.

  • To learn how the manual is organized or to learn about command syntax, read the manual page for manpages(5).

  • For more information about this technology, look for other documentation in the Apple Developer Library.

  • For general information about writing shell scripts, read Shell Scripting Primer.




STRXFRM(3)               BSD Library Functions Manual               STRXFRM(3)

NAME
     strxfrm, strxfrm_l -- transform a string under locale

LIBRARY
     Standard C Library (libc, -lc)

SYNOPSIS
     #include <string.h>

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

     #include <string.h>
     #include <xlocale.h>

     size_t
     strxfrm_l(char *restrict s1, const char *restrict s2, size_t n, locale_t loc);

DESCRIPTION
     The strxfrm() function transforms a null-terminated string pointed to by s2 according to the current
     locale collation if any, then copies the transformed string into s1.  Not more than n characters are
     copied into s1, including the terminating null character added.  If n is set to 0 (it helps to deter-mine determine
     mine an actual size needed for transformation), s1 is permitted to be a NULL pointer.

     Comparing two strings using strcmp() after strxfrm() is equal to comparing two original strings with
     strcoll().

     Although the strxfrm() function uses the current locale, the strxfrm_l() function may be passed a
     locale directly. See xlocale(3) for more information.

RETURN VALUES
     Upon successful completion, strxfrm() returns the length of the transformed string not including the
     terminating null character.  If this value is n or more, the contents of s1 are indeterminate.

SEE ALSO
     setlocale(3), strcmp(3), strcoll(3), wcsxfrm(3), xlocale(3)

STANDARDS
     The strxfrm() function conforms to ISO/IEC 9899:1990 (``ISO C90'').

BSD                              June 4, 1993                              BSD

Reporting Problems

The way to report a problem with this manual page depends on the type of problem:

Content errors
Report errors in the content of this documentation with the feedback links below.
Bug reports
Report bugs in the functionality of the described tool or API through Bug Reporter.
Formatting problems
Report formatting mistakes in the online version of these pages with the feedback links below.

Feedback