SDL_GetPrefPath

Use this function to get the "pref dir". This is meant to be where the application can write personal files (Preferences and save games, etc.) that are specific to the application. This directory is unique per user and per application.

Syntax

char* SDL_GetPrefPath(const char* org,
                      const char* app)

Function Parameters

Return Value

Returns a UTF-8 string of the user directory in platform-dependent notation. NULL if there's a problem (creating directory failed, etc.).

The return path will be guaranteed to end with a path separator ('\' on Windows, '/' on most other platforms).

The pointer returned is owned by you. Please call SDL_free() on the pointer when you are done with it.

Code Examples

char *pref_path = NULL;

int InitializePrefPath() {
    char *base_path = SDL_GetPrefPathPath("My Company", "My Awesome SDL 2 Game");
    if (base_path) {
        pref_path = SDL_strdup(base_path);
        SDL_free(pref_path);
    } else {
        /* Do something to disable writing in-game */
    }
}

Remarks

You should assume the path returned by this function is the only safe place to write files (and that SDL_GetBasePath(), while it might be writable, or even the parent of the returned path, aren't where you should be writing things).

Both the org and app strings may become part of a directory name, so please follow these rules:

• Try to use the same org string (including case-sensitivity) for all your applications that use this function.
• Always use a unique app string for each one, and make sure it never changes for an app once you've decided on it.
• Unicode characters are legal, as long as it's UTF-8 encoded, but...
• ...only use letters, numbers, and spaces. Avoid punctuation like "Game Name 2: Bad Guy's Revenge!" ... "Game Name 2" is sufficient.

Version

This function is available in SDL 2.0.1

Related Functions

• SDL_GetBasePath

CategoryAPI, CategoryFilesystem