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

SDL_EnumerateDirectory

コールバックを通してディレクトリの内容を列挙する

ヘッダ

SDL3/SDL_filesystem.h

構文

bool SDL_EnumerateDirectory(const char *path, SDL_EnumerateDirectoryCallback callback, void *userdata);

引数

const char *path列挙するディレクトリのパス名
SDL_EnumerateDirectoryCallbackcallbackディレクトリ内の各項目に対して呼ばれる関数
void *userdatacallbackに渡すポインタ

戻り値

(bool) 成功のとき真, 失敗のとき偽を戻す. SDL_GetError()を呼んで詳細を知ることができる.

詳細

この関数はアプリケーションが渡したコールバックを通してディレクトリ内の各項目を提供する. コールバックは, 全ての項目を提供する, またはコールバックがSDL_ENUM_SUCCESSまたはSDL_ENUM_FAILUREを戻すまで, ディレクトリ内のそれぞれの項目につき1回ずつ呼ばれる.

この関数は, 一般的なシステムの問題が発生した, またはコールバックがSDL_ENUM_FAILUREを戻したとき, 偽を戻す. 成功は, コールバックが列挙を完了してSDL_ENUM_SUCCESSを戻した, またはディレクトリの全ての項目を列挙したことを意味する.

スレッドセーフ

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

バージョン

SDL 3.2.0以降

SDL Wikiへのリンク

SDL_EnumerateDirectory - SDL Wiki