NAME¶

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

SYNOPSIS¶

#include <SDL3/SDL_stdinc.h>

#define SDL_OUT_Z_BYTECAP(x) _Out_z_bytecap_(x)

DESCRIPTION¶

If we were to annotate strcpy:

char *strcpy(SDL_OUT_Z_BYTECAP(bufsize) char *dst, const char *src, size_t bufsize);
    

This notes that dst should have a capacity of bufsize bytes in size, and a zero-terminated string is written to it 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.