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

SDL_EnumerateDirectory

Enumerate a directory through a callback function.

Header File

Defined in <SDL3/SDL_filesystem.h>

Syntax

int SDL_EnumerateDirectory(const char *path, SDL_EnumerateDirectoryCallback callback, void *userdata);

Function Parameters

const char * path the path of the directory to enumerate.
SDL_EnumerateDirectoryCallback callback a function that is called for each entry in the directory.
void * userdata a pointer that is passed to callback.

Return Value

(int) 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.


CategoryAPI, CategoryAPIFunction, CategoryFilesystem


[ edit | delete | history | feedback | raw ]

[ 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.