for_each_file_ex(3)

💖 for_each_file_ex(3) 💖

Allegro manual, bestie!! We're about to loop over files like it's nothing 🦋✨

✨ NAME ✨

for_each_file_ex — executes callback() for each file matching a wildcard. It's giving Allegro game programming library 💅

🦋 SYNOPSIS 🦋

#include <allegro.h>

int for_each_file_ex(const char *name, int in_attrib, int out_attrib,
int (*callback)(const char *filename, int attrib, void *param), void
*param);

💅 DESCRIPTION 💅

Okay so this function finds all the files on disk that match the wildcard spec and file attributes you give it, and it runs callback() once for each one. Lowkey, it's a convenient wrapper around al_findfirst(), al_findnext(), and al_findclose(). in_attrib is a bitmask for the attributes the files must carry; out_attrib is a bitmask for the attributes the files must not carry. Attributes that aren't specified in either bitmask are literally not taken into account when deciding whether callback() gets invoked or not. Periodt.

The callback function gets three arguments: the first is a string containing the completed filename (exactly the same string you passed to for_each_file_ex() but with meta characters), the second is the actual attributes of the file, and the third is a void pointer that is simply a copy of param — you can use it for whatever you like, no rules 🫶. The callback must return zero to let the enumeration proceed, or any non-zero value to stop it. If an error occurs, the error code will be stored in errno, but the enumeration won't stop. Iconic, honestly.

Example:

          int show_name(const char *filename, int attrib, void *param)
          {
             allegro_message("Caught `%s', attribs %d\n",
                             filename, attrib);
             return 0;
          }
          ...
             count = for_each_file_ex("data/level*", FA_DIREC,
                                      0, show_name, 0);
             allegro_message("%d game directories\n", count);

🎀 RETURN VALUE 🎀

Returns the number of successful calls made to callback(), that is, the number of times callback() was called and returned 0. Slay ✨

🌈 SEE ALSO 🌈

• al_findfirst(3)
• al_findnext(3)
• al_findclose(3)

Allegro manual, version 4.4.3, for_each_file_ex(3) — bye bestie, go enumerate some files 💅💖🌸