NAME¶

SDL_GlobStorageDirectory - Enumerate a directory tree, filtered by pattern, and return a list.

HEADER FILE¶

Defined in SDL3/SDL_storage.h

SYNOPSIS¶

#include "SDL3/SDL.h"

char ** SDL_GlobStorageDirectory(SDL_Storage *storage, const char *path, const char *pattern, SDL_GlobFlags flags, int *count);

DESCRIPTION¶

Files are filtered out if they don't match the string in pattern , which may contain wildcard characters ' ' (match everything) and '?' (match one character). If pattern is NULL, no filtering is done and all results are returned. Subdirectories are permitted, and are specified with a path separator of '/'. Wildcard characters ' separator. flags may be set to SDL_GLOB_CASEINSENSITIVE

to make the pattern matching case-insensitive.

The returned array is always NULL-terminated, for your iterating convenience, but if count is non-NULL, on return it will contain the number of items in the array, not counting the NULL terminator.

FUNCTION PARAMETERS¶

storage

a storage container.

path

the path of the directory to enumerate.

pattern

the pattern that files in the directory must match. Can be NULL.

flags

SDL_GLOB_* bitflags that affect this search.

count

on return, will be set to the number of items in the returned array. Can be NULL.

RETURN VALUE¶

(char ) Returns an array of strings on success or NULL on failure; call

SDL_GetError () for more information. The caller should pass the returned pointer to SDL_free
when done with it. This is a single allocation that should be freed with SDL_free () when it is no longer needed.

THREAD SAFETY¶

It is safe to call this function from any thread, assuming the storage object is thread-safe.

AVAILABILITY¶

This function is available since SDL 3.1.3.