SDL_GetPrefPath

ファイルが書込可能なユーザとアプリケーションで固有のパスを得る

ヘッダ

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

const char *	org	組織名
const char *	app	アプリケーション名

(const char *) 環境に依存した記述のユーザディレクトリのUTF-8文字列を戻す. 問題がある(ディレクトリの作成に失敗など)のときNULLを戻す. 不要になったときSDL_free()で解放する必要がある.

「設定ディレクトリ」を得る. これはユーザがどこにアプリケーション固有の個人ファイル(設定やセーブデータ等)を書き込める場所を表している. このディレクトリは, アプリケーションごと, ユーザごとに異なる.

この関数はネイティブのファイルシステムにふさわしい場所を選択し, 必要ならばディレクトリを生成する. そして, UTF-8の絶対パスの文字列で戻す.

Windowsならば, 文字列は次のようになる: C:¥Users¥bob¥AppData¥Roaming¥My Company¥My Program Name¥

Linuxならば, 文字列は次のようになる: /home/bob/.local/share/My Program Name/

macOSならば, 文字列は次のようになる: /Users/bob/Library/Application Support/My Program Name/

この関数が戻した場所のみ安全にファイルを書き込めるとみなすべきである. (書き込めるであろうSDL_GetBasePath()やその親ディレクトリには書き込むべきでない.)

orgとappはディレクトリの名前の一部になる. 次のルールに従うべきである.

この関数を使う全てのアプリケーションは, (大文字小文字も)同じorgを使う.
アプリケーションごとに違うappを使う. 一度決めたappは変更しない.
UTF-8でエンコードする限りUnicodeは使える. しかし...
...使うのはアルファベット, 数字, 空白のみにする. "Game Name 2: Bad Guy's Revenge!" のように記号を含めるのは避ける. "Game Name 2" で十分である.

戻されたパスの末尾はパスの区切り文字(Windowsならば'\', 他のほとんどの環境ならば'/')であることが保証されている.

この関数はどのスレッドからも安全に呼べる.

SDL 3.2.0以降