(This is the documentation for SDL3, which is the current stable version. SDL2 was the previous version!)

SDL_GetUserFolder

Finds the most suitable user folder for a specific purpose.

Header File

Defined in <SDL3/SDL_filesystem.h>

Syntax

const char * SDL_GetUserFolder(SDL_Folder folder);

Function Parameters

SDL_Folder

folder

the type of folder to find.

Return Value

(const char *) Returns either a null-terminated C string containing the full path to the folder, or NULL if an error happened.

Remarks

Many OSes provide certain standard folders for certain purposes, such as storing pictures, music or videos for a certain user. This function gives the path for many of those special locations.

This function is specifically for user folders, which are meant for the user to access and manage. For application-specific folders, meant to hold data for the application to manage, see SDL_GetBasePath() and SDL_GetPrefPath().

The returned path is guaranteed to end with a path separator ('\' on Windows, '/' on most other platforms).

If NULL is returned, the error may be obtained with SDL_GetError().

Version

This function is available since SDL 3.1.3.

---

CategoryAPI, CategoryAPIFunction, CategoryFilesystem

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