(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_INOUT_Z_CAP

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

Header File

Defined in <SDL3/SDL_stdinc.h>

Syntax

#define SDL_INOUT_Z_CAP(x) _Inout_z_cap_(x)

Remarks

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.

Version

This macro is available since SDL 3.1.3.

---

CategoryAPI, CategoryAPIMacro, CategoryStdinc

[ front page | index | search | recent changes | git repo | offline html ]

All wiki content is licensed under Creative Commons Attribution 4.0 International (CC BY 4.0).
Wiki powered by ghwikipp.