Wiki Page Content

DRAFT

SDL_WinRTGetFSPathUTF8

Use this function to retrieve a WinRT defined path on the local file system.

Syntax

const char* SDL_WinRTGetFSPathUTF8(SDL_WinRT_Path pathType)

Function Parameters

pathType

the type of path to retrieve, one of SDL_WinRT_Path

Return Value

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.

Code Examples

You can add your code example here

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: http://msdn.microsoft.com/en-us/library/windows/apps/hh464917.aspx

Version

This function is available since SDL 2.0.3.


CategoryAPI, CategorySystem

None: SDL_WinRTGetFSPathUTF8 (last edited 2014-12-27 12:36:12 by PhilippWiesemann)

Feedback
Please include your contact information if you'd like to receive a reply.
Submit