wcscmp_s.c File Reference

#include "safe_str_lib.h"

Include dependency graph for wcscmp_s.c:

Functions
EXPORT errno_t	wcscmp_s (const wchar_t *restrict dest, rsize_t dmax, const wchar_t *restrict src, rsize_t smax, int *diff)
	Compares wide string src to wide string dest. More...

Function Documentation

wcscmp_s()

EXPORT errno_t wcscmp_s	(	const wchar_t *restrict	dest,
		rsize_t	dmax,
		const wchar_t *restrict	src,
		rsize_t	smax,
		int *	diff
	)

Compares wide string src to wide string dest.

Remarks

EXTENSION TO ISO/IEC JTC1 SC22 WG14 N1172, Programming languages, environments and system software interfaces, Extensions to the C Library, Part I: Bounds-checking interfaces

Parameters

[in]	dest	wide string to compare against
[in]	dmax	restricted maximum length of wide string dest
[in]	src	wide string to be compared to dest
[in]	smax	restricted maximum length of wide string src
[out]	diff	pointer to result diff, greater than 0, equal to 0 or less than 0, if the dest is greater than, equal to or less than src respectively.

Precondition

Neither dest nor src shall be a null pointer.

diff shall not be a null pointer.

dmax/smax shall not be 0

dmax/smax shall not be greater than RSIZE_MAX_WSTR

Return values

EOK	when comparison is complete
ESNULLP	when dest/src/diff is NULL pointer
ESZEROL	when dmax/smax = 0
ESLEMAX	when dmax/smax > RSIZE_MAX_WSTR

See also

strcmp_s(), wcsncmp_s(), wcsicmp_s()