SDL_GetUserFolder - Finds the most suitable user folder for a specific purpose.
Contents
Availability
This function is available since SDL 3.2.0.
Simple Directmedia Layer SDL 3.2.20 SDL_GetUserFolder(3)
Description
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().
Function Parameters
folder the type of folder to find.
Name
SDL_GetUserFolder - Finds the most suitable user folder for a specific purpose.
Return Value
Returns either a null-terminated C string containing the full path to the folder, or NULL if an error
happened.
Synopsis
#include<SDL3/SDL_filesystem.h>constchar*SDL_GetUserFolder(SDL_Folderfolder);
