Scroll to navigation

SDL_wcslcpy(3) SDL3 FUNCTIONS SDL_wcslcpy(3)

NAME

SDL_wcslcpy - Copy a wide string.

HEADER FILE

Defined in SDL3/SDL_stdinc.h

SYNOPSIS

#include "SDL3/SDL.h"
size_t SDL_wcslcpy(wchar_t *dst, const wchar_t *src, size_t maxlen);

DESCRIPTION

This function copies maxlen

• 1 wide characters from src to dst , then appends a null terminator. src and dst must not overlap.

If maxlen is 0, no wide characters are copied and no null terminator is written.

FUNCTION PARAMETERS

The destination buffer. Must not be NULL, and must not overlap with src .
The null-terminated wide string to copy. Must not be NULL, and must not overlap with dst .
The length (in wide characters) of the destination buffer.

RETURN VALUE

Returns The length (in wide characters, excluding the null terminator) of src .

THREAD SAFETY

It is safe to call this function from any thread.

AVAILABILITY

This function is available since SDL 3.1.3.

SEE ALSO

(3), SDL_wcslcat(3)

SDL 3.1.6 Simple Directmedia Layer