Man page - sdl_out_z_cap(3)

Packages contains this manual

Package:  libsdl3-doc
apt-get install libsdl3-doc

Documentations in package:
• libsdl3-doc
• libsdl3-dev

Manual

SDL_OUT_Z_CAP

NAME
HEADER FILE
SYNOPSIS
DESCRIPTION
AVAILABILITY

---

NAME

SDL_OUT_Z_CAP - Macro that annotates function params with output string buffer size.

HEADER FILE

Defined in SDL3/SDL_stdinc.h

SYNOPSIS

#include "SDL3/SDL.h"

#define SDL_OUT_Z_CAP(x) _Out_z_cap_(x)

DESCRIPTION

If we were to annotate snprintf :

int snprintf(SDL_OUT_Z_CAP(maxlen) char *text, size_t maxlen, const char *fmt, ...);

This notes that text is a null-terminated C string, should be maxlen bytes in size, and is only written to by the function. The compiler or other analysis tools can warn when this doesn’t appear to be the case.

On compilers without this annotation mechanism, this is defined to nothing.

AVAILABILITY

This macro is available since SDL 3.2.0.

---