Functions | |
| void | deleteForsPAF (ForsPAF *paf) |
| Destroy a PAF object. | |
| ForsPAF * | newForsPAF (const char *name, const char *type, const char *id, const char *desc) |
| Create a new PAF object. | |
| int | forsPAFIsEmpty (const ForsPAF *paf) |
| Check whether a PAF object is empty. | |
| size_t | forsPAFGetSize (const ForsPAF *paf) |
| Get the actual size of the given PAF object. | |
| int | forsPAFIsValidName (const char *name) |
| Verify that the given string is a valid PAF keyword. | |
| int | forsPAFAppendBool (ForsPAF *paf, const char *name, int value, const char *comment) |
| Append a boolean value to a PAF object. | |
| int | forsPAFAppendInt (ForsPAF *paf, const char *name, int value, const char *comment) |
| Append a integer value to a PAF object. | |
| int | forsPAFAppendDouble (ForsPAF *paf, const char *name, double value, const char *comment) |
| Append a double value to a PAF object. | |
| int | forsPAFAppendString (ForsPAF *paf, const char *name, const char *value, const char *comment) |
| Append a string value to a PAF object. | |
| int | forsPAFWrite (ForsPAF *paf) |
| Write a PAF object to a disk file. | |
| void deleteForsPAF | ( | ForsPAF * | paf | ) |
Destroy a PAF object.
| paf | PAF object to destroy. |
| int forsPAFAppendBool | ( | ForsPAF * | paf, | |
| const char * | name, | |||
| int | value, | |||
| const char * | comment | |||
| ) |
Append a boolean value to a PAF object.
| paf | PAF object to which the record is appended. | |
| name | Parameter name. | |
| value | Parameter value. | |
| comment | Parameter description. |
EXIT_SUCCESS if the record was successfully appended, or EXIT_FAILURE otherwise.| int forsPAFAppendDouble | ( | ForsPAF * | paf, | |
| const char * | name, | |||
| double | value, | |||
| const char * | comment | |||
| ) |
Append a double value to a PAF object.
| paf | PAF object to which the record is appended. | |
| name | Parameter name. | |
| value | Parameter value. | |
| comment | Parameter description. |
EXIT_SUCCESS if the record was successfully appended, or EXIT_FAILURE otherwise.| int forsPAFAppendInt | ( | ForsPAF * | paf, | |
| const char * | name, | |||
| int | value, | |||
| const char * | comment | |||
| ) |
Append a integer value to a PAF object.
| paf | PAF object to which the record is appended. | |
| name | Parameter name. | |
| value | Parameter value. | |
| comment | Parameter description. |
EXIT_SUCCESS if the record was successfully appended, or EXIT_FAILURE otherwise.| int forsPAFAppendString | ( | ForsPAF * | paf, | |
| const char * | name, | |||
| const char * | value, | |||
| const char * | comment | |||
| ) |
Append a string value to a PAF object.
| paf | PAF object to which the record is appended. | |
| name | Parameter name. | |
| value | Parameter value string. | |
| comment | Parameter description. |
EXIT_SUCCESS if the record was successfully appended, or EXIT_FAILURE otherwise.| size_t forsPAFGetSize | ( | const ForsPAF * | paf | ) |
Get the actual size of the given PAF object.
| paf | PAF object to query. |
| int forsPAFIsEmpty | ( | const ForsPAF * | paf | ) |
Check whether a PAF object is empty.
| paf | PAF object to query. |
| int forsPAFIsValidName | ( | const char * | name | ) |
Verify that the given string is a valid PAF keyword.
| name | Name string to verify. |
| int forsPAFWrite | ( | ForsPAF * | paf | ) |
Write a PAF object to a disk file.
| paf | PAF object to save. |
EXIT_SUCCESS if the object was successfully written to the file, otherwise EXIT_FAILURE is returned.| ForsPAF* newForsPAF | ( | const char * | name, | |
| const char * | type, | |||
| const char * | id, | |||
| const char * | desc | |||
| ) |
Create a new PAF object.
| name | Parameter file name. | |
| type | Parameter file type. | |
| id | Parameter file identifier string. | |
| desc | Short description for the parameter file. |
NULL maybe passed for id and/or desc. The argument name will be used as the file name in case the PAF object is written to a disk file.
1.4.7