50 lines
No EOL
1.5 KiB
C
50 lines
No EOL
1.5 KiB
C
#ifndef CONFIGOPS
|
|
#define CONFIGOPS
|
|
|
|
#include "StandardConstants.h"
|
|
|
|
typedef struct ConfigDataTypeStruct
|
|
{
|
|
char metaDataFileName[STD_STR_LEN];
|
|
} ConfigDataType;
|
|
|
|
/*
|
|
Name: clearConfigData
|
|
Process: frees dynamically allocated config data structure
|
|
if it has not already been freed
|
|
Function Input/Parameters: pointer to config data structure (ConfigDataType *)
|
|
Function Output/Parameters: none
|
|
Function Output/Returned: NULL (ConfigDataType *)
|
|
Device Input/Device: none
|
|
Device Output/Device: none
|
|
Dependencies: ???
|
|
*/
|
|
ConfigDataType *clearConfigData(ConfigDataType *configData);
|
|
|
|
/*
|
|
Name: displayConfigData
|
|
Process: screen dump/display of all config data
|
|
Function Input/Parameters: pointer to config data structure (ConfigDataType *)
|
|
Function Output/Parameters: none
|
|
Function Output/Returned: none
|
|
Device Input/Device: none
|
|
Device Output/Monitor: displayed as spec'd
|
|
Dependencies: ???
|
|
*/
|
|
void displayConfigData(ConfigDataType *configData);
|
|
|
|
/*
|
|
Name: getConfigData
|
|
Process: driver function for capturing config data from config file
|
|
Function Input/Parameters: file name (const char *)
|
|
Function Output/Parameters: pointer to config data pointer (ConfigDataType **)
|
|
end/result state message pointer (char *)
|
|
Function Output/Returned: Boolean result of data access operation (bool)
|
|
Device Input/File: config data uploaded
|
|
Device Output/Device: none
|
|
Dependencies: ???
|
|
*/
|
|
bool getConfigData(const char *fileName,
|
|
ConfigDataType **configData, char *endStateMsg);
|
|
|
|
#endif // CONFIGOPS
|