Movatterモバイル変換

strxfrm(3p) — Linux manual page

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

PROLOG        top

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

NAME        top

       strxfrm, strxfrm_l — string transformation

SYNOPSIS        top

       #include <string.h>       size_t strxfrm(char *restricts1, const char *restricts2, size_tn);       size_t strxfrm_l(char *restricts1, const char *restricts2,           size_tn, locale_tlocale);

DESCRIPTION        top

       Forstrxfrm(): The functionality described on this reference page       is aligned with the ISO C standard. Any conflict between the       requirements described here and the ISO C standard is       unintentional. This volume of POSIX.1‐2017 defers to the ISO C       standard.       Thestrxfrm() andstrxfrm_l() functions shall transform the string       pointed to bys2 and place the resulting string into the array       pointed to bys1.  The transformation is such that ifstrcmp() is       applied to two transformed strings, it shall return a value       greater than, equal to, or less than 0, corresponding to the       result ofstrcoll() orstrcoll_l(), respectively, applied to the       same two original strings with the same locale.  No more thann       bytes are placed into the resulting array pointed to bys1,       including the terminating NUL character. Ifn is 0,s1 is       permitted to be a null pointer. If copying takes place between       objects that overlap, the behavior is undefined.       Thestrxfrm() andstrxfrm_l() functions shall not change the       setting oferrno if successful.       Since no return value is reserved to indicate an error, an       application wishing to check for error situations should seterrno       to 0, then callstrxfrm() orstrxfrm_l(), then checkerrno.       The behavior is undefined if thelocale argument tostrxfrm_l() is       the special locale object LC_GLOBAL_LOCALE or is not a valid       locale object handle.

RETURN VALUE        top

       Upon successful completion,strxfrm() andstrxfrm_l() shall return       the length of the transformed string (not including the       terminating NUL character). If the value returned isn or more,       the contents of the array pointed to bys1 are unspecified.       On error,strxfrm() andstrxfrm_l() may seterrno but no return       value is reserved to indicate an error.

ERRORS        top

       These functions may fail if:EINVALThe string pointed to by thes2 argument contains              characters outside the domain of the collating sequence.The following sections are informative.

EXAMPLES        top

       None.

APPLICATION USAGE        top

       The transformation function is such that two transformed strings       can be ordered bystrcmp() as appropriate to collating sequence       information in the current locale (categoryLC_COLLATE).       The fact that whenn is 0s1 is permitted to be a null pointer is       useful to determine the size of thes1 array prior to making the       transformation.

RATIONALE        top

       None.

FUTURE DIRECTIONS        top

       None.

SEE ALSO        top

strcmp(3p),strcoll(3p)       The Base Definitions volume of POSIX.1‐2017,string.h(0p)

COPYRIGHT        top

       Portions of this text are reprinted and reproduced in electronic       form from IEEE Std 1003.1-2017, Standard for Information       Technology -- Portable Operating System Interface (POSIX), The       Open Group Base Specifications Issue 7, 2018 Edition, Copyright       (C) 2018 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 athttp://www.opengroup.org/unix/online.html .       Any typographical or formatting errors that appear in this page       are most likely to have been introduced during the conversion of       the source files to man page format. To report such errors, seehttps://www.kernel.org/doc/man-pages/reporting_bugs.html .IEEE/The Open Group                2017STRXFRM(3P)

Pages that refer to this page:string.h(0p), localeconv(3p), setlocale(3p), strcoll(3p)

HTML rendering created 2025-09-06 byMichael Kerrisk, author ofThe Linux Programming Interface. For details of in-depthLinux/UNIX system programming training courses that I teach, lookhere. Hosting byjambit GmbH.