string_array_parameter.h File Reference

#include "parameter.h"
#include "parameter_set.h"
#include "grassroots_service_library.h"
#include "service.h"

Include dependency graph for string_array_parameter.h:

Go to the source code of this file.

Data Structures
struct	StringArrayParameter

Functions
StringArrayParameter *	AllocateStringArrayParameter (const struct ServiceData *service_data_p, const char *const name_s, const char *const display_name_s, const char *const description_s, char **default_value_ss, char **current_value_ss, const size_t num_values, ParameterLevel level)
StringArrayParameter *	AllocateStringArrayParameterFromJSON (const json_t *param_json_p, const struct Service *service_p, const bool concise_flag, const ParameterType *pt_p)
Parameter *	EasyCreateAndAddStringArrayParameterToParameterSet (const ServiceData *service_data_p, ParameterSet *params_p, ParameterGroup *group_p, const char *const name_s, const char *const display_name_s, const char *const description_s, char **default_values_ss, uint32 num_entries, uint8 level)
Parameter *	CreateAndAddStringArrayParameterToParameterSet (const ServiceData *service_data_p, ParameterSet *params_p, ParameterGroup *group_p, const char *const name_s, const char *const display_name_s, const char *const description_s, char **default_value_ss, char **current_value_ss, uint32 num_entries, uint8 level)
char *	GetStringArrayParameterCurrentValuesAsFlattenedString (const StringArrayParameter *param_p)
const char **	GetStringArrayValuesForParameter (ParameterSet *param_set_p, const char *param_s, size_t *num_entries_p)
void	FreeStringArrayParameter (StringArrayParameter *param_p)
bool	IsStringArrayParameter (const Parameter *param_p)
const char **	GetStringArrayParameterCurrentValues (const StringArrayParameter *param_p)
const char **	GetStringArrayParameterDefaultValues (const StringArrayParameter *param_p)
bool	GetCurrentStringArrayParameterValuesFromParameterSet (const ParameterSet *const params_p, const char *const name_s, const char ***values_ppp, size_t *num_entries_p)
const char *	GetStringArrayParameterCurrentValueAtIndex (const StringArrayParameter *param_p, const size_t index)
bool	SetStringArrayParameterCurrentValues (StringArrayParameter *param_p, char **values_ss, const size_t num_values)
bool	SetStringArrayParameterDefaultValues (StringArrayParameter *param_p, char **values_ss, const size_t num_values)
size_t	GetNumberOfStringArrayCurrentParameterValues (const StringArrayParameter *param_p)
char **	CopyStringArray (char **src_ss, const size_t num_values)

Function Documentation

AllocateStringArrayParameter()

StringArrayParameter* AllocateStringArrayParameter	(	const struct ServiceData *	service_data_p,
		const char *const	name_s,
		const char *const	display_name_s,
		const char *const	description_s,
		char **	default_value_ss,
		char **	current_value_ss,
		const size_t	num_values,
		ParameterLevel	level
	)

AllocateStringArrayParameterFromJSON()

StringArrayParameter* AllocateStringArrayParameterFromJSON	(	const json_t *	param_json_p,
		const struct Service *	service_p,
		const bool	concise_flag,
		const ParameterType *	pt_p
	)

EasyCreateAndAddStringArrayParameterToParameterSet()

Parameter* EasyCreateAndAddStringArrayParameterToParameterSet	(	const ServiceData *	service_data_p,
		ParameterSet *	params_p,
		ParameterGroup *	group_p,
		const char *const	name_s,
		const char *const	display_name_s,
		const char *const	description_s,
		char **	default_values_ss,
		uint32	num_entries,
		uint8	level
	)

CreateAndAddStringArrayParameterToParameterSet()

Parameter* CreateAndAddStringArrayParameterToParameterSet	(	const ServiceData *	service_data_p,
		ParameterSet *	params_p,
		ParameterGroup *	group_p,
		const char *const	name_s,
		const char *const	display_name_s,
		const char *const	description_s,
		char **	default_value_ss,
		char **	current_value_ss,
		uint32	num_entries,
		uint8	level
	)

GetStringArrayParameterCurrentValuesAsFlattenedString()

char* GetStringArrayParameterCurrentValuesAsFlattenedString

(

const StringArrayParameter *

param_p

)

GetStringArrayValuesForParameter()

const char** GetStringArrayValuesForParameter	(	ParameterSet *	param_set_p,
		const char *	param_s,
		size_t *	num_entries_p
	)

FreeStringArrayParameter()

void FreeStringArrayParameter

(

StringArrayParameter *

param_p

)

IsStringArrayParameter()

bool IsStringArrayParameter

(

const Parameter *

param_p

)

GetStringArrayParameterCurrentValues()

const char** GetStringArrayParameterCurrentValues

(

const StringArrayParameter *

param_p

)

GetStringArrayParameterDefaultValues()

const char** GetStringArrayParameterDefaultValues

(

const StringArrayParameter *

param_p

)

GetCurrentStringArrayParameterValuesFromParameterSet()

bool GetCurrentStringArrayParameterValuesFromParameterSet	(	const ParameterSet *const	params_p,
		const char *const	name_s,
		const char ***	values_ppp,
		size_t *	num_entries_p
	)

GetStringArrayParameterCurrentValueAtIndex()

const char* GetStringArrayParameterCurrentValueAtIndex	(	const StringArrayParameter *	param_p,
		const size_t	index
	)

SetStringArrayParameterCurrentValues()

bool SetStringArrayParameterCurrentValues	(	StringArrayParameter *	param_p,
		char **	values_ss,
		const size_t	num_values
	)

SetStringArrayParameterDefaultValues()

bool SetStringArrayParameterDefaultValues	(	StringArrayParameter *	param_p,
		char **	values_ss,
		const size_t	num_values
	)

GetNumberOfStringArrayCurrentParameterValues()

size_t GetNumberOfStringArrayCurrentParameterValues

(

const StringArrayParameter *

param_p

)

CopyStringArray()

char** CopyStringArray	(	char **	src_ss,
		const size_t	num_values
	)