.\" This manpage content is licensed under Creative Commons
.\"  Attribution 4.0 International (CC BY 4.0)
.\"   https://creativecommons.org/licenses/by/4.0/
.\" This manpage was generated from SDL's wiki page for SDL_GetPath:
.\"   https://wiki.libsdl.org/SDL_GetPath
.\" Generated with SDL/build-scripts/wikiheaders.pl
.\" Please report issues in this manpage's content at:
.\"   https://github.com/libsdl-org/sdlwiki/issues/new
.\" Please report issues in the generation of this manpage from the wiki at:
.\"   https://github.com/libsdl-org/SDL/issues/new?title=Misgenerated%20manpage%20for%20SDL_GetPath
.\" SDL can be found at https://libsdl.org/
.de URL
\$2 \(laURL: \$1 \(ra\$3
..
.if \n[.g] .mso www.tmac
.TH SDL_GetPath 3 "SDL 3.0.0" "SDL" "SDL3 FUNCTIONS"
.SH NAME
SDL_GetPath \- Finds the most suitable OS-provided folder for @p folder, and returns its path in OS-specific notation\[char46]
.SH SYNOPSIS
.nf
.B #include \(dqSDL3/SDL.h\(dq
.PP
.BI "char* SDL_GetPath(SDL_Folder folder);
.fi
.SH DESCRIPTION
Many OSes provide certain standard folders for certain purposes, such as
storing pictures, music or videos for a certain user\[char46] This function gives
the path for many of those special locations\[char46]

Note that the function is expensive, and should be called once at the
beginning of the execution and kept for as long as needed\[char46]

The returned value is owned by the caller and should be freed with

.BR SDL_free
()\[char46]

If NULL is returned, the error may be obtained with

.BR SDL_GetError
()\[char46]

.SH FUNCTION PARAMETERS
.TP
.I folder
The type of folder to find
.SH RETURN VALUE
Returns Either a null-terminated C string containing the full path to the
folder, or NULL if an error happened\[char46]

.SH AVAILABILITY
This function is available since SDL 3\[char46]0\[char46]0\[char46]

.SH SEE ALSO
.BR SDL_Folder (3)