Copyright 1989 AT&T. Copyright (c) 2003, Sun Microsystems, Inc. All Rights Reserved. Portions Copyright (c) 1992, X/Open Company Limited. All Rights Reserved.
Sun Microsystems, Inc. gratefully acknowledges The Open Group for permission to reproduce portions of its copyrighted documentation. Original documentation from The Open Group can be obtained online at
http://www.opengroup.org/bookstore/.
The Institute of Electrical and Electronics Engineers and The Open Group, have given us permission to reprint portions of their documentation. In the following statement, the phrase "this text" refers to portions of the system documentation. Portions of this text are reprinted and reproduced in electronic form in the Sun OS Reference Manual, from IEEE Std 1003.1, 2004 Edition, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 6, Copyright (C) 2001-2004 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between these versions 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 at http://www.opengroup.org/unix/online.html.
This notice shall appear on any product containing this material.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
#include <string.h> size_t strxfrm(char *restrict s1, const char *restrict s2, size_t n);
The strxfrm() function transforms the string pointed to by s2 and places the resulting string into the array pointed to by s1. The transformation is such that if strcmp(3C) is applied to two transformed strings, it returns a value greater than, equal to or less than 0, corresponding to the result of strcoll(3C) applied to the same two original strings. No more than n bytes are placed into the resulting array pointed to by s1, including the terminating null byte. If n is 0, s1 is permitted to be a null pointer. If copying takes place between objects that overlap, the behavior is undefined.
The strxfrm() function does not change the setting of errno if successful.
Since no return value is reserved to indicate an error, an application wishing to check for error situations should set errno to 0, then call strxfrm(), then check errno.
Upon successful completion, strxfrm() returns the length of the transformed string (not including the terminating null byte). If the value returned is n or more, the contents of the array pointed to by s1 are indeterminate.
On error, strxfrm() may set errno but no return value is reserved to indicate the error.
The transformation function is such that two transformed strings can be ordered by strcmp(3C) as appropriate to collating sequence information in the program's locale (category LC_COLLATE).
The fact that when n is 0, s1 is permitted to be a null pointer, is useful to determine the size of the s1 array prior to making the transformation.
Example 1 A sample of using the strxfm() function.
The value of the following expression is the size of the array needed to hold the transformation of the string pointed to by s.
1 + strxfrm(NULL, s, 0);
LC_COLLATE database for locale
See attributes(5) for descriptions of the following attributes:
| ATTRIBUTE TYPE ATTRIBUTE VALUE |
| CSI Enabled |
| Interface Stability Standard |
| MT-Level MT-Safe with exceptions |
The strxfrm() function can be used safely in a multithreaded application, as long as setlocale(3C) is not being called to change the locale.
localedef(1), setlocale(3C), strcmp(3C), strcoll(3C), wscoll(3C), attributes(5), environ(5), standards(5)