prg_tfile_generic_data_file_read()
Abstract
Reads the contents of a file to a list of strings.
Syntax
prg_tfile_generic_data_file_read (filename, file_type, list_ptr, options)
| Argument | Type | Description |
|---|---|---|
filename |
const char * |
Base file name of the file to be read. |
file_type |
PrgT_Tfile_Type |
Typed file type of the file to be read; must be .gsf or .gdf. |
list_ptr |
PrgT_List * |
String list to receive the file contents. |
options |
int |
Must be PRGC_TFILE_GENERIC_DATA_READ_OPT_NONE. |
Return Type
PrgT_Compcode
PrgC_Compcode_Success if the file is read successfully; PrgC_Compcode_Failure otherwise.
Header
prg_file_funcs.h
Details
This function reads the contents of a generic settings file (.gsf) or generic data file (.gdf) into a list of strings, then appends that list to the list specified by list_ptr.
This function provides similar, but expanded functionality as compared to prg_gdf_read() and is the preferred choice for reading data files.