Parameter definition. More...

#include <PARA_Lib.h>

Data Fields
uint16_t	GroupID
	Identifier of a parameter group. See page Grouping of parameters. More...

uint16_t	ParaID
	Unique identifier of the parameter. More...

uint16_t	Access
	Access restriction, or-concatenated elements of the enum ZUGRIFF. See page Access restrictions. More...

uint16_t	SubIdCount
	Number of entries in case of a data-field. More...

const char *	Name
	Name of the parameter. It is shown in the list of parameters. More...

const char *	Description
	Description/Help-text of the parameter. It is shown with F1. See page Help-page for a parameter. More...

const char *	Format
	Format of the parameter-value. See page Customized format of parameter values. More...

void *	Data
	Pointer to actual data of the parameter. Element of type ParaData_*. More...

ReadFunction *	OnRead
	user-defined read-function, see page User defined onRead and onWrite functions. More...

WriteFunction *	OnWrite
	user-defined write-function, see page User defined onRead and onWrite functions. More...

RestoreDefaultFunction *	SetToDefault
	user-defined restore-function, see page User defined onRead and onWrite functions. More...

uint32_t	Flags
	special flag, see page Special flags for parameters. More...

const char *	SubstitutionalTexts
	Substitutional-texts to replace value with textx. See page Substitution of parameter values with texts. More...

Detailed Description

Parameter definition.

Field Documentation

◆ Access

uint16_t Access

Access restriction, or-concatenated elements of the enum ZUGRIFF. See page Access restrictions.

◆ Data

void* Data

Pointer to actual data of the parameter. Element of type ParaData_*.

◆ Description

const char* Description

Description/Help-text of the parameter. It is shown with F1. See page Help-page for a parameter.

◆ Flags

uint32_t Flags

special flag, see page Special flags for parameters.

◆ Format

const char* Format

Format of the parameter-value. See page Customized format of parameter values.

◆ GroupID

uint16_t GroupID

Identifier of a parameter group. See page Grouping of parameters.

◆ Name

const char* Name

Name of the parameter. It is shown in the list of parameters.

◆ OnRead

ReadFunction* OnRead

user-defined read-function, see page User defined onRead and onWrite functions.

◆ OnWrite

WriteFunction* OnWrite

user-defined write-function, see page User defined onRead and onWrite functions.

◆ ParaID

uint16_t ParaID

Unique identifier of the parameter.

◆ SetToDefault

RestoreDefaultFunction* SetToDefault

user-defined restore-function, see page User defined onRead and onWrite functions.

◆ SubIdCount

uint16_t SubIdCount

Number of entries in case of a data-field.

◆ SubstitutionalTexts

const char* SubstitutionalTexts

Substitutional-texts to replace value with textx. See page Substitution of parameter values with texts.

The documentation for this struct was generated from the following file:

src/PARA_Lib.h

Data Fields