SDL_strlcpy(3)

SDL_strlcpy3

Copy a string.

Usage

#include "SDL3/SDL.h"

size_t SDL_strlcpy(char *dst, const char *src, size_t maxlen);

Header file

Defined in SDL3/SDL_stdinc.h

Overview

This function copies up to maxlen

• 1 characters from src to dst , then appends a null terminator.

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

If you want to copy an UTF-8 string but need to ensure that multi-byte sequences are not truncated, consider using

SDL_utf8strlcpy ().

Function parameters

dst

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

src

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

maxlen

The length (in characters) of the destination buffer.

Return value

Returns the length (in 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.

From libsdl3-doc 3.2.10+ds-1 in Debian 13 (Trixie). Parsed by carta from the page's man source.