Namespaces
Variants
Views
Actions

Difference between revisions of "c/string/wide/wcscat"

From cppreference.com
< c‎ | string‎ | wide
m (Update links.)
m (+C17 ref, fmt)
 
(5 intermediate revisions by 4 users not shown)
Line 1: Line 1:
−
{{c/title| wcscat}}
+
{{c/title| wcscat | wcscat_s}}
 
{{c/string/wide/navbar}}
 
{{c/string/wide/navbar}}
−
{{ddcl | header=wchar.h |
+
{{dcl begin}}
 +
{{dcl header | wchar.h}}
 +
{{dcl rev begin|num=1}}
 +
{{dcl | since=c95 | until=c99 |
 
wchar_t *wcscat( wchar_t *dest, const wchar_t *src );
 
wchar_t *wcscat( wchar_t *dest, const wchar_t *src );
 
}}
 
}}
−
 
+
{{dcl | since=c99 |
−
Appends a wide string pointed to by {{tt|src}} to a wide string pointed to by {{tt|dest}}. The resulting wide string is null-terminated. If the strings overlap, the behavior is undefined.  
+
wchar_t *wcscat( wchar_t *restrict dest, const wchar_t *restrict src );
 +
}}
 +
{{dcl rev end}}
 +
{{dcl |num=2| since=c11 |
 +
errno_t wcscat_s( wchar_t *restrict dest, rsize_t destsz,
 +
                  const wchar_t *restrict src );
 +
}}
 +
{{dcl end}}
 +
@1@ Appends a copy of the wide string pointed to by {{tt|src}} to the end of the wide string pointed to by {{tt|dest}}. The wide character {{tt|src[0]}} replaces the null terminator at the end of {{tt|dest}}. The resulting wide string is null-terminated. The behavior is undefined if the destination array is not large enough for the contents of both {{tt|str}} and {{tt|dest}} and the terminating null wide character. The behavior is undefined if the strings overlap.  
 +
@2@ Same as {{v|1}}, except that it may clobber the rest of the destination array (from the last character written to {{tt|destsz}}) with unspecified values and that the following errors are detected at runtime and call the currently installed [[c/error/set_constraint_handler_s|constraint handler]] function:
 +
:* {{tt|src}} or {{tt|dest}} is a null pointer
 +
:* {{tt|destsz}} is zero or greater than {{c|RSIZE_MAX/sizeof(wchar_t)}}
 +
:* there is no null terminator in the first {{tt|destsz}} wide characters of {{tt|dest}}
 +
:* truncation would occur (the available space at the end of {{tt|dest}} would not fit every wide character, including the null terminator, of {{tt|src}})
 +
:* overlap would occur between the source and the destination strings
 +
:{{c/ext1 availability|wcscat_s}}
  
 
===Parameters===
 
===Parameters===
Line 11: Line 29:
 
{{par | dest | pointer to the null-terminated wide string to append to}}
 
{{par | dest | pointer to the null-terminated wide string to append to}}
 
{{par | src | pointer to the null-terminated wide string to copy from}}
 
{{par | src | pointer to the null-terminated wide string to copy from}}
 +
{{par | destsz | maximum number of characters to write, typically the size of the destination buffer}}
 
{{par end}}
 
{{par end}}
  
 
===Return value===
 
===Return value===
−
{{tt|dest}}
+
@1@ returns a copy of {{tt|dest}}
 +
@2@ returns zero on success, returns non-zero on error. Also, on error, writes {{c|L'\0'}} to {{c|dest[0]}} (unless {{tt|dest}} is a null pointer or {{tt|destsz}} is zero or greater than {{c|RSIZE_MAX/sizeof(wchar_t)}}).
  
 
===Example===
 
===Example===
Line 20: Line 40:
 
  |
 
  |
 
  | code=
 
  | code=
 +
#include <wchar.h>
 +
#include <stdio.h>
 +
#include <locale.h>
 +
 +
int main(void)
 +
{
 +
    wchar_t str[50] = L"Земля, прощай.";
 +
    wcscat(str, L" ");
 +
    wcscat(str, L"В добрый путь.");
 +
    setlocale(LC_ALL, "en_US.utf8");
 +
    printf("%ls", str);
 +
}
 
  | output=
 
  | output=
 +
Земля, прощай. В добрый путь.
 
}}
 
}}
 +
 +
===References===
 +
{{ref std c17}}
 +
{{ref std | section=7.29.4.3.1  | title=The wcscat function | p=315}}
 +
{{ref std | section=K.3.9.2.2.1 | title=The wcscat_s function | p=466}}
 +
{{ref std end}}
 +
{{ref std c11}}
 +
{{ref std | section=7.29.4.3.1  | title=The wcscat function | p=432}}
 +
{{ref std | section=K.3.9.2.2.1 | title=The wcscat_s function | p=642-643}}
 +
{{ref std end}}
 +
{{ref std c99}}
 +
{{ref std | section=7.24.4.3.1  | title=The wcscat function | p=378}}
 +
{{ref std end}}
  
 
===See also===
 
===See also===
 
{{dsc begin}}
 
{{dsc begin}}
 
{{dsc inc | c/string/wide/dsc wcsncat}}
 
{{dsc inc | c/string/wide/dsc wcsncat}}
 +
{{dsc inc | c/string/byte/dsc strcat}}
 
{{dsc inc | c/string/wide/dsc wcscpy}}
 
{{dsc inc | c/string/wide/dsc wcscpy}}
 
{{dsc see cpp | cpp/string/wide/wcscat}}
 
{{dsc see cpp | cpp/string/wide/wcscat}}
 
{{dsc end}}
 
{{dsc end}}
  
−
[[de:c/string/wide/wcscat]]
+
{{langlinks|ar|cs|de|es|fr|it|ja|ko|pl|pt|ru|tr|zh}}
−
[[es:c/string/wide/wcscat]]
+
−
[[fr:c/string/wide/wcscat]]
+
−
[[it:c/string/wide/wcscat]]
+
−
[[ja:c/string/wide/wcscat]]
+
−
[[pt:c/string/wide/wcscat]]
+
−
[[ru:c/string/wide/wcscat]]
+
−
[[zh:c/string/wide/wcscat]]
+

Latest revision as of 12:20, 27 June 2022

 
C
 
Strings library
 
Null-terminated wide strings
Functions
Character manipulation
(C95)
(C95)
(C95)
(C95)
(C95)
(C95)
(C99)
(C95)
(C95)
(C95)
(C95)
(C95)
(C95)
(C95)
(C95)
(C95)
(C95)
(C95)
Conversions to numeric formats
(C95)(C99)
(C95)(C99)
(C99)(C95)(C99)
(C99)(C99)
String manipulation
(C95)(C11)
(C95)(C11)
(C95)(C11)
wcscatwcscat_s
(C95)(C11)
(C95)(C11)
(C95)
(C95)
(C95)
(C95)
(C95)
(C95)
(C95)
(C95)
(C95)
(C95)
(C95)(C11)
Array manipulation
(C95)(C11)
(C95)(C11)
(C95)
(C95)
(C95)
 
Defined in header <wchar.h>
(1)
wchar_t *wcscat( wchar_t *dest, const wchar_t *src );
 (since C95)
(until C99)
wchar_t *wcscat( wchar_t *restrict dest, const wchar_t *restrict src );
 (since C99)
errno_t wcscat_s( wchar_t *restrict dest, rsize_t destsz,
                  const wchar_t *restrict src );
 (2) (since C11)
1) Appends a copy of the wide string pointed to by src to the end of the wide string pointed to by dest. The wide character src[0] replaces the null terminator at the end of dest. The resulting wide string is null-terminated. The behavior is undefined if the destination array is not large enough for the contents of both str and dest and the terminating null wide character. The behavior is undefined if the strings overlap.
2) Same as (1), except that it may clobber the rest of the destination array (from the last character written to destsz) with unspecified values and that the following errors are detected at runtime and call the currently installed constraint handler function:
  • src or dest is a null pointer
  • destsz is zero or greater than RSIZE_MAX/sizeof(wchar_t)
  • there is no null terminator in the first destsz wide characters of dest
  • truncation would occur (the available space at the end of dest would not fit every wide character, including the null terminator, of src)
  • overlap would occur between the source and the destination strings
As with all bounds-checked functions, wcscat_s is only guaranteed to be available if __STDC_LIB_EXT1__ is defined by the implementation and if the user defines __STDC_WANT_LIB_EXT1__ to the integer constant 1 before including <wchar.h>.

Contents

[edit] Parameters

dest - pointer to the null-terminated wide string to append to
src - pointer to the null-terminated wide string to copy from
destsz - maximum number of characters to write, typically the size of the destination buffer

[edit] Return value

1) returns a copy of dest
2) returns zero on success, returns non-zero on error. Also, on error, writes L'\0' to dest[0] (unless dest is a null pointer or destsz is zero or greater than RSIZE_MAX/sizeof(wchar_t)).

[edit] Example

Run this code
#include <wchar.h> 
#include <stdio.h>
#include <locale.h>
 
int main(void) 
{
    wchar_t str[50] = L"Земля, прощай.";
    wcscat(str, L" ");
    wcscat(str, L"В добрый путь.");
    setlocale(LC_ALL, "en_US.utf8");
    printf("%ls", str);
}

Output: 

Земля, прощай. В добрый путь.

[edit] References

  • C17 standard (ISO/IEC 9899:2018):
  • 7.29.4.3.1 The wcscat function (p: 315)
  • K.3.9.2.2.1 The wcscat_s function (p: 466)
  • C11 standard (ISO/IEC 9899:2011):
  • 7.29.4.3.1 The wcscat function (p: 432)
  • K.3.9.2.2.1 The wcscat_s function (p: 642-643)
  • C99 standard (ISO/IEC 9899:1999):
  • 7.24.4.3.1 The wcscat function (p: 378)

[edit] See also

(C95)(C11)
 appends a certain amount of wide characters from one wide string to another
(function) [edit]
(C11)
 concatenates two strings
(function) [edit]
(C95)(C11)
 copies one wide string to another
(function) [edit]
C++ documentation for wcscat
Retrieved from "https://en.cppreference.com/mwiki/index.php?title=c/string/wide/wcscat&oldid=140654"