table of contents
- experimental 3.1.0+ds-1
SDL_OpenUserStorage(3) | SDL3 FUNCTIONS | SDL_OpenUserStorage(3) |
NAME¶
SDL_OpenUserStorage - Opens up a container for a user's unique read/write filesystem.
SYNOPSIS¶
#include "SDL3/SDL.h"
SDL_Storage* SDL_OpenUserStorage(const char *org, const char *app, SDL_PropertiesID props);
DESCRIPTION¶
While title storage can generally be kept open throughout runtime, user storage should only be opened when the client is ready to read/write files. This allows the backend to properly batch file operations and flush them when the container has been closed; ensuring safe and optimal save I/O.
FUNCTION PARAMETERS¶
RETURN VALUE¶
Returns a user storage container on success or NULL on failure; call
SDL_GetError () for more information.
AVAILABILITY¶
This function is available since SDL 3.0.0.
SEE ALSO¶
SDL_CloseStorage(3), SDL_GetStorageFileSize(3), SDL_GetStorageSpaceRemaining(3), SDL_OpenTitleStorage(3), SDL_ReadStorageFile(3), SDL_StorageReady(3), SDL_WriteStorageFile(3)
SDL 3.1.0 | SDL |