Skip to content

Files

Latest commit

3f3b6d3 · Nov 28, 2016

History

History
32 lines (24 loc) · 1.27 KB

finslib_file_read.md

File metadata and controls

32 lines (24 loc) · 1.27 KB

Libfins API Reference

finslib_file_read( sys, disk, path, filename, data, file_position, num_bytes );

Parameters

Parameter Type Description
sys struct fins_sys_tp * A pointer to a structure with the FINS context
disk uint16_t The disk on which the file is located
path const char * The subdirectory in which the file is located
filename const char * The name of the file
data unsigned char * The buffer where the file contents must be stored
file_position size_t The position in the file where reading should start
num_bytes size_t * The amount of bytes requested and at function return the actual amount of bytes read

Return Value

Type Description
int A return value from the list FINS_RETVAL_... indicating the result of the query

Description

See Also