---
name: "SDL_wcslcpy"
section: "3"
platform: "linux"
package: "libsdl3-doc"
version: "3.2.10+ds-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/SDL_wcslcpy"
---

# SDL\_wcslcpy(3)

Copy a wide string.

## 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

- *dst*

  The destination buffer. Must not be NULL, and must not overlap with **src** .

- *src*

  The null-terminated wide string to copy. Must not be NULL, and must not overlap with **dst** .

- *maxlen*

  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.2.0.

## SEE ALSO

**•**(3), [**SDL\_wcslcat**(3)](/SDL_wcslcat/3.md)