目次 - SDL 3.0 API(機能別) - ファイルシステム - SDL_GetUserFolder

SDL_GetUserFolder

指定した種類のユーザフォルダを得る

ヘッダ

SDL3/SDL_filesystem.h

構文

const char * SDL_GetUserFolder(SDL_Folder folder);

引数

SDL_Folderfolder求めるフォルダの種類

戻り値

(const char *) フォルダのフルパスの文字列を戻す. 失敗のときNULLを戻す.

詳細

多くのOSには特定の目的(写真, 音楽, 動画など)のためのフォルダがある. この関数はその内の多くのパスを提供する.

この関数はユーザ固有のフォルダ(それぞれのユーザがアクセス・管理するフォルダ)を扱う. アプリケーション固有のフォルダ(アプリケーションが管理するデータのフォルダ)についてはSDL_GetBasePath()SDL_GetPrefPath()を使用すること.

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

この関数がNULLを戻した場合, SDL_GetError()を呼んで詳細を知ることができる.

スレッドセーフ

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

バージョン

SDL 3.2.0以降

SDL Wikiへのリンク

SDL_GetUserFolder - SDL Wiki