SDL_DialogFileCallback.3type - Man Page
Callback used by file dialog functions.
Synopsis
#include <SDL3/SDL_dialog.h> typedef void (SDLCALL *SDL_DialogFileCallback)(void *userdata, const char * const *filelist, int filter);
Description
The specific usage is described in each function.
If filelist is:
· NULL, an error occurred. Details can be obtained with SDL_GetError().
· A pointer to NULL, the user either didn't choose any file or canceled the dialog.
· A pointer to non-NULL, the user chose one or more files. The argument is a null-terminated array of pointers to UTF-8 encoded strings, each containing a path.
The filelist argument should not be freed; it will automatically be freed when the callback returns.
The filter argument is the index of the filter that was selected, or -1 if no filter was selected or if the platform or method doesn't support fetching the selected filter.
In Android, the filelist are content:// URIs. They should be opened using SDL_IOFromFile() with appropriate modes. This applies both to open and save file dialog.
Function Parameters
- userdata
an app-provided pointer, for the callback's use.
- filelist
the file(s) chosen by the user.
- filter
index of the selected filter.
Availability
This datatype is available since SDL 3.2.0.
See Also
SDL_DialogFileFilter(3type), SDL_ShowOpenFileDialog(3), SDL_ShowSaveFileDialog(3), SDL_ShowOpenFolderDialog(3), SDL_ShowFileDialogWithProperties(3)