Movatterモバイル変換

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.

#include <wchar.h> size_t wcsxfrm(wchar_t *restrictws1, const wchar_t *restrictws2, size_tn); size_t wcsxfrm_l(wchar_t *restrictws1, const wchar_t *restrictws2, size_tn, locale_tlocale);

DESCRIPTION top

Forwcsxfrm(): 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. Thewcsxfrm() andwcsxfrm_l() functions shall transform the wide- character string pointed to byws2 and place the resulting wide- character string into the array pointed to byws1. The transformation shall be such that ifwcscmp() is applied to two transformed wide strings, it shall return a value greater than, equal to, or less than 0, corresponding to the result ofwcscoll() andwcscoll_l() applied to the same two original wide-character strings, and the sameLC_COLLATE category of the current locale or the locale objectlocale, respectively. No more thann wide- character codes shall be placed into the resulting array pointed to byws1, including the terminating null wide-character code. Ifn is 0,ws1 is permitted to be a null pointer. If copying takes place between objects that overlap, the behavior is undefined. Thewcsxfrm() andwcsxfrm_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 callwcsxfrm() orwcsxfrm_l(), then checkerrno. The behavior is undefined if thelocale argument towcsxfrm_l() is the special locale object LC_GLOBAL_LOCALE or is not a valid locale object handle.

RETURN VALUE top

Thewcsxfrm() andwcsxfrm_l() functions shall return the length of the transformed wide-character string (not including the terminating null wide-character code). If the value returned isn or more, the contents of the array pointed to byws1 are unspecified. On error, thewcsxfrm() andwcsxfrm_l() functions may seterrno, but no return value is reserved to indicate an error.

These functions may fail if:EINVALThe wide-character string pointed to byws2 contains wide- character codes outside the domain of the collating sequence.The following sections are informative.

APPLICATION USAGE top

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

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 2017WCSXFRM(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.