SDL_OpenUserStorage(3)

Usage

#include "SDL3/SDL.h"

SDL_Storage * SDL_OpenUserStorage(const char *org, const char *app, SDL_PropertiesID props);

Header file

Defined in SDL3/SDL_storage.h

Overview

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

`org`	the name of your organization.
`app`	the name of your application.
`props`	a property list that may contain backend-specific information.

Return value

( SDL_Storage
*) Returns a user storage container on success or NULL on failure; call SDL_GetError () for more information.

SDL_CloseStorage(3) Closes and frees a storage container. SDL_GetStorageFileSize(3) Query the size of a file within a storage container. SDL_GetStorageSpaceRemaining(3) Queries the remaining space in a storage container. SDL_OpenTitleStorage(3) Opens up a read-only container for the application's filesystem. SDL_ReadStorageFile(3) Synchronously read a file from a storage container into a client-provided buffer. SDL_StorageReady(3) Checks if the storage container is ready to use. SDL_WriteStorageFile(3) Synchronously write a file from client memory into a storage container.

Referred to by

SDL_CloseStorage(3) Closes and frees a storage container. SDL_OpenFileStorage(3) Opens up a container for local filesystem storage. SDL_OpenTitleStorage(3) Opens up a read-only container for the application's filesystem.