FAT16 directory functions
[FAT16 support]

---

Detailed Description

Functions for managing directories.

Functions
struct fat16_dir_struct *	fat16_open_dir (struct fat16_fs_struct *fs, const struct fat16_dir_entry_struct *dir_entry)
	Opens a directory.
void	fat16_close_dir (struct fat16_dir_struct *dd)
	Closes a directory descriptor.
uint8_t	fat16_read_dir (struct fat16_dir_struct *dd, struct fat16_dir_entry_struct *dir_entry)
	Reads the next directory entry contained within a parent directory.
uint8_t	fat16_reset_dir (struct fat16_dir_struct *dd)
	Resets a directory handle.
uint8_t	fat16_create_dir (struct fat16_dir_struct *parent, const char *dir, struct fat16_dir_entry_struct *dir_entry)
	Creates a directory.
uint8_t	fat16_delete_dir (struct fat16_fs_struct *fs, struct fat16_dir_entry_struct *dir_entry)
	Deletes a directory.

---

Function Documentation

struct fat16_dir_struct* fat16_open_dir	(	struct fat16_fs_struct *	fs,
		const struct fat16_dir_entry_struct *	dir_entry
	)			[read]

Opens a directory.

Parameters:

[in]	fs	The filesystem on which the directory to open resides.
[in]	dir_entry	The directory entry which stands for the directory to open.

Returns:

An opaque directory descriptor on success, 0 on failure.

See also:

fat16_close_dir

void fat16_close_dir

(

struct fat16_dir_struct *

dd

)

Closes a directory descriptor.

This function destroys a directory descriptor which was previously obtained by calling fat16_open_dir(). When this function returns, the given descriptor will be invalid.

Parameters:

[in]

dd

The directory descriptor to close.

See also:

fat16_open_dir

uint8_t fat16_read_dir	(	struct fat16_dir_struct *	dd,
		struct fat16_dir_entry_struct *	dir_entry
	)

Reads the next directory entry contained within a parent directory.

Parameters:

[in]	dd	The descriptor of the parent directory from which to read the entry.
[out]	dir_entry	Pointer to a buffer into which to write the directory entry information.

Returns:

0 on failure, 1 on success.

See also:

fat16_reset_dir

uint8_t fat16_reset_dir

(

struct fat16_dir_struct *

dd

)

Resets a directory handle.

Resets the directory handle such that reading restarts with the first directory entry.

Parameters:

[in]

dd

The directory handle to reset.

Returns:

0 on failure, 1 on success.

See also:

fat16_read_dir

uint8_t fat16_create_dir	(	struct fat16_dir_struct *	parent,
		const char *	dir,
		struct fat16_dir_entry_struct *	dir_entry
	)

Creates a directory.

Creates a directory and obtains its directory entry. If the directory to create already exists, its directory entry will be returned within the dir_entry parameter.

Note:

The notes which apply to fat16_create_file also apply to this function.

Parameters:

[in]	parent	The handle of the parent directory of the new directory.
[in]	dir	The name of the directory to create.
[out]	dir_entry	The directory entry to fill for the new directory.

Returns:

0 on failure, 1 on success.

See also:

fat16_delete_dir

uint8_t fat16_delete_dir	(	struct fat16_fs_struct *	fs,
		struct fat16_dir_entry_struct *	dir_entry
	)

Deletes a directory.

This is just a synonym for fat16_delete_file(). If a directory is deleted without first deleting its subdirectories and files, disk space occupied by these files will get wasted as there is no chance to release it and mark it as free.

Parameters:

[in]	fs	The filesystem on which to operate.
[in]	dir_entry	The directory entry of the directory to delete.

Returns:

0 on failure, 1 on success.

See also:

fat16_create_dir