SDL Wiki
(This is the documentation for SDL3, which is under heavy development and the API is changing! SDL2 is the current stable version!)


Retrieve a WinRT defined path on the local file system.

Header File

Defined in <SDL3/SDL_system.h>


const char * SDL_WinRTGetFSPath(SDL_WinRT_Path pathType);

Function Parameters

SDL_WinRT_Path pathType the type of path to retrieve, one of SDL_WinRT_Path.

Return Value

(const char *) Returns a UTF-8 string (8-bit, multi-byte) containing the path, or NULL if the path is not available for any reason; call SDL_GetError() for more information.


Not all paths are available on all versions of Windows. This is especially true on Windows Phone. Check the documentation for the given SDL_WinRT_Path for more information on which path types are supported where.

Documentation on most app-specific path types on WinRT can be found on MSDN, at the URL:

The returned string follows the SDL_GetStringRule.


This function is available since SDL 3.0.0.

CategoryAPI, CategoryAPIFunction, CategorySystem

[ edit | delete | history | feedback | raw ]

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