strnset_s.c File Reference

#include "safe_str_lib.h"

Include dependency graph for strnset_s.c:

Functions
EXPORT errno_t	strnset_s (char *restrict dest, rsize_t dmax, int value, rsize_t n)
	Sets maximal n characters of dest to a character value, but not the final NULL character. More...

Function Documentation

strnset_s()

EXPORT errno_t strnset_s	(	char *restrict	dest,
		rsize_t	dmax,
		int	value,
		rsize_t	n
	)

Sets maximal n characters of dest to a character value, but not the final NULL character.

With SAFECLIB_STR_NULL_SLACK defined all elements following the terminating null character (if any) written in the array of dmax characters pointed to by dest are nulled.

Remarks

EXTENSION TO

• ISO/IEC TR 24731, Programming languages, environments and system software interfaces, Extensions to the C Library, Part I: Bounds-checking interfaces
• Implemented in the Windows secure API as _strnset_s()

Parameters

[out]	dest	string that will be set.
[in]	dmax	restricted maximum length of dest
[in]	value	character value to write
[in]	n	number of characters to be written

Precondition

dest shall not be a null pointer, and shall be null-terminated.

dmax shall not be greater than RSIZE_MAX_STR.

dmax shall not equal zero.

n shall not be greater than dmax

value shall not be greater than 255

Return values

EOK	when successful
ESNULLP	when dest is NULL pointer
ESZEROL	when dmax = 0
ESLEMAX	when dmax > RSIZE_MAX_STR or value > 255
ESNOSPC	when n > dmax

See also

strzero_s(), strset_s(), wcsnset_s(), strispassword_s()