NAME¶

SDL_INOUT_Z_CAP - Macro that annotates function params with input/output string buffer size.

SYNOPSIS¶

#include <SDL3/SDL_stdinc.h>

#define SDL_INOUT_Z_CAP(x) _Inout_z_cap_(x)

DESCRIPTION¶

If we were to annotate strlcat:

size_t strlcat(SDL_INOUT_Z_CAP(maxlen) char *dst, const char *src, size_t maxlen);
    

This notes that dst is a null-terminated C string, should be maxlen bytes in size, and is both read from and 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.