Procházet zdrojové kódy

include: Small clarification on directory enumeration documentation.

Ryan C. Gordon před 1 rokem
rodič
revize
4e09e58f62
2 změnil soubory, kde provedl 8 přidání a 0 odebrání
  1. 4 0
      include/SDL3/SDL_filesystem.h
  2. 4 0
      include/SDL3/SDL_storage.h

+ 4 - 0
include/SDL3/SDL_filesystem.h

@@ -272,6 +272,10 @@ typedef int (SDLCALL *SDL_EnumerateDirectoryCallback)(void *userdata, const char
  * callback, called once for each directory entry, until all results have been
  * provided or the callback returns <= 0.
  *
+ * This will return false if there was a system problem in general, or if a
+ * callback returns -1. A successful return means a callback returned 1 to
+ * halt enumeration, or all directory entries were enumerated.
+ *
  * \param path the path of the directory to enumerate.
  * \param callback a function that is called for each entry in the directory.
  * \param userdata a pointer that is passed to `callback`.

+ 4 - 0
include/SDL3/SDL_storage.h

@@ -320,6 +320,10 @@ extern SDL_DECLSPEC bool SDLCALL SDL_CreateStorageDirectory(SDL_Storage *storage
  * callback, called once for each directory entry, until all results have been
  * provided or the callback returns <= 0.
  *
+ * This will return false if there was a system problem in general, or if a
+ * callback returns -1. A successful return means a callback returned 1 to
+ * halt enumeration, or all directory entries were enumerated.
+ *
  * \param storage a storage container.
  * \param path the path of the directory to enumerate.
  * \param callback a function that is called for each entry in the directory.