prg_tfile_parse_to_file_write()
Abstract
Writes the contents of a parse data structure to a file.
Syntax
prg_tfile_parse_to_file_write (parse_ptr, filename, file_type)
| Argument | Type | Description |
|---|---|---|
parse_ptr |
PrgT_File_Parse * |
pointer to the parse data structure to be written. |
filename |
const char * |
base file name of file to be written. |
file_type |
PrgT_Tfile_Type |
typed file type (an enumeration) of the file to be written. |
Return Type
PrgT_Compcode
PrgC_Compcode_Success if the data structure is written successfully; PrgC_Compcode_Failure otherwise.
Header
prg_file_funcs.h
Details
This function writes the contents of the given parse data structure to a file with the given name and type. If the file name is in the format <project_name>-<scenario_name>, it will get associated with the project and scenario of that name.
Note that this function was created (along with functions like prg_file_parse_create(), prg_file_parse_block_from_list_create(), and prg_file_parse_name_value_pair_create()) to enable you to create and manipulate the parse data structures.