{"id":3246,"date":"2018-08-25T00:01:20","date_gmt":"2018-08-25T07:01:20","guid":{"rendered":"https:\/\/c-for-dummies.com\/blog\/?p=3246"},"modified":"2018-09-01T12:45:08","modified_gmt":"2018-09-01T19:45:08","slug":"reading-a-directory","status":"publish","type":"post","link":"https:\/\/c-for-dummies.com\/blog\/?p=3246","title":{"rendered":"Reading a Directory"},"content":{"rendered":"

I’m refusing to call it a “folder.” That nonsense gained popularity with the Macintosh and then Windows. Before then, it was a directory<\/em>, a list of files stored on media. Special C language functions are available to read and manipulate directories, which helps your programs manage files and do other fun file stuff.
\n
\nA directory is really a special type of file, a data container that acts as a database referencing other files stored on the media. The media’s file system determines how the files are organized and accessed. The directory holds all that information, such as the file’s physical location, its name, timestamps, permissions, and other trivia. These details are accessible when you use the proper C language functions.<\/p>\n

To access a directory, use the opendir()<\/em> function. It’s prototyped in the dirent.h<\/code> header file as:<\/p>\n

DIR *opendir(const char *filename);<\/code><\/p>\n

The function requires a string argument, a name or path to a directory. The value returned is a DIR<\/em> pointer, similar to the FILE<\/em> pointer returned by fopen()<\/em>.<\/p>\n

After opening the directory and doing whatever, you use the closedir()<\/em> function to close the directory:<\/p>\n

int closedir(DIR *dirp);<\/code><\/p>\n

The function requires a DIR<\/em> pointer (dirp<\/code>, heh) and returns 0 upon success, otherwise -1. Use the errno<\/code><\/a> global variable to further examine the issue when -1 is returned.<\/p>\n

In the following code, the current directory (abbreviated as .<\/code> ) is opened and closed:<\/p>\n

\r\n#include <stdio.h>\r\n#include <dirent.h>\r\n\r\nint main()\r\n{\r\n    DIR *folder;\r\n\r\n    folder = opendir(\".\");\r\n    if(folder == NULL)\r\n    {\r\n        puts(\"Unable to read directory\");\r\n        return(1);\r\n    }\r\n    else\r\n    {\r\n        puts(\"Directory is opened!\");\r\n    }\r\n    closedir(folder);\r\n\r\n    return(0);\r\n}<\/pre>\n
The DIR<\/em> pointer variable folder<\/code> acts as the directory handle for the opendir()<\/em> function in Line 8. If it’s NULL<\/code>, the program quits. Otherwise a simple string is output and the directory is closed in Line 18. Here’s sample output:<\/p>\n
Directory is opened!<\/code><\/p>\n
Opening and closing a directory is boring, but I like to build upon code when presenting a new concept. To expand the program and make it useful, the readdir()<\/em> function is added. Here’s how it’s prototyped, also in the dirent.h<\/code> header file:<\/p>\n
struct dirent *readdir(DIR *dirp);<\/code><\/p>\n
Structure variable dirent<\/code> is a pointer that contains information about a specific entry read from a directory, referenced by the DIR<\/em> pointer used in the readdir()<\/em> function. This function is called repeatedly until NULL<\/code> is returned, indicating no further entries are available in the directory.<\/p>\n
The dirent<\/code> structure is customized based on the file system. A key member worthy of access is d_name<\/code>, which represent the directory entry’s filename. The following code demonstrates how the d_name<\/code> structure member can be used when reading a directory:<\/p>\n
\r\n#include <stdio.h>\r\n#include <dirent.h>\r\n\r\nint main()\r\n{\r\n    DIR *folder;\r\n    struct dirent *entry;\r\n    int files = 0;\r\n\r\n    folder = opendir(\".\");\r\n    if(folder == NULL)\r\n    {\r\n        perror(\"Unable to read directory\");\r\n        return(1);\r\n    }\r\n\r\n    while( (entry=readdir(folder)) )\r\n    {\r\n        files++;\r\n        printf(\"File %3d: %s\\n\",\r\n                files,\r\n                entry->d_name\r\n              );\r\n    }\r\n\r\n    closedir(folder);\r\n\r\n    return(0);\r\n}<\/pre>\n
This code is the same as the previous example, with a while<\/em> loop inserted to read the directory entries. The loop spins as long as the value returned from readdir()<\/em> isn’t NULL<\/code>. For each item found, int<\/em> variable files<\/code> tracks its sequential number (which is part of this code and not part of the file system) and entry->d_name<\/code> prints its name:<\/p>\n
File   1: .\r\nFile   2: ..\r\nFile   3: 0825a.c\r\nFile   4: 0825b.c\r\nFile   5: 08exercise-a.c\r\nFile   6: 08exercise-b.c\r\nFile   7: 0901.c\r\nFile   8: 0908.c\r\nFile   9: a.out\r\nFile  10: gettysburg.txt\r\nFile  11: sto<\/code><\/pre>\n
Directories are read like files, but with special rules, restrictions, and formats. Continue reading →<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[2],"tags":[],"class_list":["post-3246","post","type-post","status-publish","format-standard","hentry","category-main"],"_links":{"self":[{"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/3246","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=3246"}],"version-history":[{"count":6,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/3246\/revisions"}],"predecessor-version":[{"id":3278,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=\/wp\/v2\/posts\/3246\/revisions\/3278"}],"wp:attachment":[{"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=3246"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=3246"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/c-for-dummies.com\/blog\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=3246"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}
Directory entries .<\/code> and ..<\/code> represent the current and parent directories. The other items are files, though I know that sto<\/code> is another directory. In next week’s Lesson<\/a>, I discuss how to differentiate between standard files and directory entries.<\/p>\n","protected":false},"excerpt":{"rendered":"