(This is the legacy documentation for SDL2, the previous stable version; SDL3 is the current stable version.)

SDL_WinRTGetFSPathUTF8

Retrieve a WinRT defined path on the local file system.

Header File

Syntax

const char * SDL_WinRTGetFSPathUTF8(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.

Remarks

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:

https://msdn.microsoft.com/en-us/library/windows/apps/hh464917.aspx

Version

This function is available since SDL 2.0.3.