Component: Read

command result_t StdControl.init (void)
command result_t StdControl.start (void)
command result_t StdControl.stop (void)
command result_t ReadCheck.notOpen (fileblock_t block)
command result_t FileRead.open (uint8_t fd, const char *filename) open a file for sequential reads.
void openComplete(fileresult_t result)
event void IFileMetaRead.nextFile (struct fileEntry *file, fileresult_t result)
command result_t FileRead.close (uint8_t fd) Close file currently open for reading

Returns: SUCCESS if a file was open, FAIL otherwise
command result_t FileRead.read (uint8_t fd, void *buffer, filesize_t n) Read bytes sequentially from open file.
event void IFileRead.readDone (uint8_t fd, filesize_t nRead, fileresult_t result)
command result_t FileRead.getRemaining (uint8_t fd) Return number of bytes remaining in file.
event void IFileRead.remaining (uint8_t fd, filesize_t n, fileresult_t result)
event result_t FileRead.opened (uint8_t fd, fileresult_t result)
event result_t FileRead.readDone (uint8_t fd, void *buffer, filesize_t nRead, fileresult_t result)
event result_t FileRead.remaining (uint8_t fd, filesize_t n, fileresult_t result)

command result_t FileRead.open (uint8_t fd, const char *filename)

open a file for sequential reads.

Parameters:	filename - Name of file to open. Must not be stack allocated.
Returns:	SUCCESS: attempt proceeds, `opened` will be signaled FAIL: filesystem is busy or another file is open for reading

command result_t FileRead.read (uint8_t fd, void *buffer, filesize_t n)

Read bytes sequentially from open file.

Parameters:	buffer - Target to read into n - Number of bytes to read
Returns:	SUCCESS: attempt proceeds, `readDone` will be signaled FAIL: no file was open for reading, or a read is in progress

command result_t FileRead.getRemaining (uint8_t fd)

Return number of bytes remaining in file.

Returns: SUCCESS: attempt proceeds, remaining will be signaled
FAIL: no file was open for reading, or a read is in progress