wcscat_s.c File Reference

#include "safe_str_lib.h"

Include dependency graph for wcscat_s.c:

Functions
EXPORT errno_t	wcscat_s (wchar_t *restrict dest, rsize_t dmax, const wchar_t *restrict src)
	The wcscat_s function appends a copy of the wide string pointed to by src (including the terminating null character) to the end of the wide string pointed to by dest. More...

Function Documentation

wcscat_s()

EXPORT errno_t wcscat_s	(	wchar_t *restrict	dest,
		rsize_t	dmax,
		const wchar_t *restrict	src
	)

The wcscat_s function appends a copy of the wide string pointed to by src (including the terminating null character) to the end of the wide string pointed to by dest.

The initial wide character from src overwrites the null character at the end of dest.

All elements following the terminating null wide character (if any) written by wcscat_s in the array of dmax characters pointed to by dest take unspecified values when wcscat_s returns. With SAFECLIB_STR_NULL_SLACK defined the rest is cleared with 0.

Remarks

SPECIFIED IN

• C11 standard (ISO/IEC 9899:2011): K.3.9.2.2.1 The wcscat_s function (p: 642-643) http://en.cppreference.com/w/c/string/wide/wcscat
• ISO/IEC TR 24731, Programming languages, environments and system software interfaces, Extensions to the C Library, Part I: Bounds-checking interfaces

Parameters

[out]	dest	pointer to wide string that will be extended by src if dmax allows. The wide string is null terminated. If the resulting concatenated wide string is less than dmax, the remaining slack space is nulled.
[in]	dmax	restricted maximum length of the resulting dest, including the null
[in]	src	pointer to the wide string that will be concatenaed to string dest

Precondition

Neither dest nor src shall be a null pointer

dmax shall not equal zero

dmax shall not be greater than RSIZE_MAX_WSTR

dmax shall be greater than wcsnlen_s(src,m).

Copying shall not take place between objects that overlap

Note

C11 uses RSIZE_MAX, not RSIZE_MAX_WSTR.

Returns

If there is a runtime-constraint violation, then if dest is not a null pointer and dmax is greater than zero and not greater than RSIZE_MAX_WSTR, then wcscat_s nulls dest.

Return values

EOK	when successful operation, all the wide characters from src were appended to dest and the result in dest is null terminated.
ESNULLP	when dest or src is a NULL pointer
ESZEROL	when dmax = 0
ESLEMAX	when dmax > RSIZE_MAX_WSTR
ESUNTERM	when dest not terminated in the first dmax wide characters
ESOVRLP	when src overlaps with dest

See also

wcscat_s(), strcpy_s(), strncpy_s()