wcscat(3)wcscat(3)NAME
wcscat, wcscmp, wcscpy - Perform operations on wide-character strings
SYNOPSIS
#include <wchar.h>
wchar_t *wcscat(
wchar_t *wcstring1,
const wchar_t *wcstring2 ); int wcscmp
const wchar_t *wcstring1,
const wchar_t *wcstring2 ); wchar_t *wcscpy(
wchar_t *wcstring1,
const wchar_t *wcstring2 );
LIBRARY
Standard C Library (libc)
STANDARDS
Interfaces documented on this reference page conform to industry stan‐
dards as follows:
wcscat(), wcscmp(), wcscpy(): XSH5.0
Refer to the standards(5) reference page for more information about
industry standards and associated tags.
PARAMETERS
Points to a location containing the first wide-character string.
Points to a location containing the second wide-character string.
DESCRIPTION
The wcscat(), wcscmp(), and wcscpy() functions operate on null-termi‐
nated, wide-character strings. The string arguments to these functions
are expected to contain a null wide character marking the end of the
string. Boundary checking is not done when a copy or concatenation
operation is performed.
The wcscat() function appends a copy of the wide-character string
pointed to by the wcstring2 parameter (including the terminating null
wide character) to the end of the wide-character string pointed to by
the wcstring1 parameter. The initial wide-character code of wcstring2
overwrites the null wide-character code at the end of wcstring1. If the
append operation is done on overlapping objects, the behavior of the
wcscat() function is undefined.
The wcscmp() function compares wcstring1 to wcstring2. The wcscmp()
function compares wide characters until it finds two wide characters
that are not equal or until it has reached a terminating null wide
character.
The wcscmp() function compares strings based on the machine collating
order. It does not use the locale-dependent sorting order. Use the
wcscoll() function for locale-dependent sorting.
The wcscpy() function copies the contents of the wcstring2 parameter
(including the ending null wide character) into the wcstring1 parame‐
ter. If copying occurs between overlapping objects, the behavior of the
wcscpy() function is undefined.
RETURN VALUES
On successful completion, the wcscat() and wcscpy() functions return a
pointer to the resulting string, wcstring1.
On successful completion, the wcscmp() function returns an integer
whose value is greater than 0 (zero) if wcstring1 is greater than
wcstring2, returns 0 (zero) if the strings are equivalent, and returns
an integer whose value is less than 0 (zero) if wcstring1 is less than
wcstring2. The sign of a nonzero return value is determined by the sign
of the difference between the values of the first pair of wide-charac‐
ter codes that differ in the objects being compared.
[Tru64 UNIX] When a successful comparison cannot be made, the wcscat()
and wcscpy() functions return a null pointer, and the wcscmp() function
returns zero.
SEE ALSO
Functions: string(3), wcschr(3), wcscoll(3), wcsncat(3), wcsspn(3),
wcsstr(3)
Standards: standards(5)wcscat(3)
