nn::fs::Directory::Read Member Function

Syntax

s32 Read(
     DirectoryEntry pEntries[],
     s32 numEntries
);

Arguments

Name Description
out pEntries[] Location to which to load directory entries.
in numEntries Maximum number of directory entries to load.

Return Values

Returns the number of entries that were actually loaded. Returns 0 when it has finished scanning all the entries.

Description

Loads the specified number of entries from a directory.

Up to numEntries entries are read from the current file position and copied to the region at the address specified by pEntries.

This function is implemented to show an error screen when errors occur internally, whether or not such errors are fatal. Control does not return from the function in this case. Use nn::fs::Directory::TryRead on everything other than ROM archives.

To read details about error handling, see Handling Errors During File and Directory Operations.

Revision History

2010/12/24
Added a link to the error handling page.
2010/01/29
Initial version.

CONFIDENTIAL