devela::_dep::sdl3::sys::storage

Function SDL_EnumerateStorageDirectory

pub unsafe extern "C" fn SDL_EnumerateStorageDirectory(
    storage: *mut SDL_Storage,
    path: *const i8,
    callback: Option<unsafe extern "C" fn(_: *mut c_void, _: *const i8, _: *const i8) -> SDL_EnumerationResult>,
    userdata: *mut c_void,
) -> bool
Available on crate feature dep_sdl3 only.
Expand description

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

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 either SDL_ENUM_SUCCESS or SDL_ENUM_FAILURE.

This will return false if there was a system problem in general, or if a callback returns SDL_ENUM_FAILURE. A successful return means a callback returned SDL_ENUM_SUCCESS to halt enumeration, or all directory entries were enumerated.

If path is NULL, this is treated as a request to enumerate the root of the storage container’s tree. An empty string also works for this.

§Parameters

  • storage: a storage container.
  • path: the path of the directory to enumerate, or NULL for the root.
  • callback: a function that is called for each entry in the directory.
  • userdata: a pointer that is passed to callback.

§Return value

Returns true on success or false on failure; call SDL_GetError() for more information.

§Availability

This function is available since SDL 3.2.0.

§See also