1STRXFRM(3P)                POSIX Programmer's Manual               STRXFRM(3P)
2
3
4

PROLOG

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

NAME

13       strxfrm, strxfrm_l — string transformation
14

SYNOPSIS

16       #include <string.h>
17
18       size_t strxfrm(char *restrict s1, const char *restrict s2, size_t n);
19       size_t strxfrm_l(char *restrict s1, const char *restrict s2,
20           size_t n, locale_t locale);
21

DESCRIPTION

23       For strxfrm(): The functionality described on this  reference  page  is
24       aligned  with the ISO C standard. Any conflict between the requirements
25       described here and the ISO C standard is unintentional. This volume  of
26       POSIX.1‐2008 defers to the ISO C standard.
27
28       The  strxfrm()  and  strxfrm_l()  functions  shall transform the string
29       pointed to by s2 and place the resulting string into the array  pointed
30       to  by  s1.   The transformation is such that if strcmp() is applied to
31       two transformed strings, it shall return a value  greater  than,  equal
32       to,  or  less  than 0, corresponding to the result of strcoll() or str‐
33       coll_l(), respectively, applied to the same two original  strings  with
34       the  same  locale.   No more than n bytes are placed into the resulting
35       array pointed to by s1, including the terminating NUL character.  If  n
36       is  0,  s1  is  permitted  to be a null pointer. If copying takes place
37       between objects that overlap, the behavior is undefined.
38
39       The strxfrm() and strxfrm_l() functions shall not change the setting of
40       errno if successful.
41
42       Since  no return value is reserved to indicate an error, an application
43       wishing to check for error situations should set errno to 0, then  call
44       strxfrm() or strxfrm_l(), then check errno.
45
46       The  behavior is undefined if the locale argument to strxfrm_l() is the
47       special locale object LC_GLOBAL_LOCALE or is not a valid locale  object
48       handle.
49

RETURN VALUE

51       Upon  successful completion, strxfrm() and strxfrm_l() shall return the
52       length of the transformed string (not  including  the  terminating  NUL
53       character).  If  the  value  returned is n or more, the contents of the
54       array pointed to by s1 are unspecified.
55
56       On error, strxfrm() and strxfrm_l() may set errno but no  return  value
57       is reserved to indicate an error.
58

ERRORS

60       These functions may fail if:
61
62       EINVAL The  string  pointed  to  by the s2 argument contains characters
63              outside the domain of the collating sequence.
64
65       The following sections are informative.
66

EXAMPLES

68       None.
69

APPLICATION USAGE

71       The transformation function is such that two transformed strings can be
72       ordered by strcmp() as appropriate to collating sequence information in
73       the current locale (category LC_COLLATE).
74
75       The fact that when n is 0 s1 is permitted to be a null pointer is  use‐
76       ful to determine the size of the s1 array prior to making the transfor‐
77       mation.
78

RATIONALE

80       None.
81

FUTURE DIRECTIONS

83       None.
84

SEE ALSO

86       strcmp(), strcoll()
87
88       The Base Definitions volume of POSIX.1‐2008, <string.h>
89
91       Portions of this text are reprinted and reproduced in  electronic  form
92       from IEEE Std 1003.1, 2013 Edition, Standard for Information Technology
93       -- Portable Operating System Interface (POSIX),  The  Open  Group  Base
94       Specifications Issue 7, Copyright (C) 2013 by the Institute of Electri‐
95       cal and Electronics Engineers,  Inc  and  The  Open  Group.   (This  is
96       POSIX.1-2008  with  the  2013  Technical Corrigendum 1 applied.) In the
97       event of any discrepancy between this version and the original IEEE and
98       The  Open Group Standard, the original IEEE and The Open Group Standard
99       is the referee document. The original Standard can be  obtained  online
100       at http://www.unix.org/online.html .
101
102       Any  typographical  or  formatting  errors that appear in this page are
103       most likely to have been introduced during the conversion of the source
104       files  to  man page format. To report such errors, see https://www.ker
105       nel.org/doc/man-pages/reporting_bugs.html .
106
107
108
109IEEE/The Open Group                  2013                          STRXFRM(3P)
Impressum