(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)

SDL_EnumerateStorageDirectory

Enumerate a directory in a storage container through a callback function.

Header File

Defined in <SDL3/SDL_storage.h>

Syntax

int SDL_EnumerateStorageDirectory(SDL_Storage *storage, const char *path, SDL_EnumerateDirectoryCallback callback, void *userdata);

Function Parameters

storage a storage container
path the path of the directory to enumerate
callback a function that is called for each entry in the directory
userdata a pointer that is passed to callback

Return Value

Returns 0 on success or a negative error code on failure; call SDL_GetError() for more information.

Remarks

This function provides every directory entry through an app-provided callback, called once for each directory entry, until all results have been provided or the callback returns <= 0.

Version

This function is available since SDL 3.0.0.

See Also


CategoryAPI, CategoryAPIFunction, CategoryStorage