Functions: Settings

The following functions allow for accessing the settings of EPLAN 21.

Please note that the improper use of these functions may impair the performance of EPLAN 21.

eplGetEplanSetting

EplHandle
eplGetEplanSetting(const EplChar* section,
                   const EplChar* key,
                   Eplchar*          buf,
                   EplSize         buflen);

Query of an EPLAN 21 registry entry via section and key.

Return Description
EplHandle EPL_ERROR if the transferred buffer was too small or the entry does not exist, otherwise EPL_OK. If the buffer is too small, the error EPL_ERR_API_BUFFER_TOO_SMALL is entered into the error log. If the entry does not exist the error EPL_ERR_API_SETTING_KEY_NOT_EXISTING is entered in the error log.
Input Type Description
section const EplChar* Name of the EPLAN 21 registry section.
key const EplChar* Name of the EPLAN 21 registry key.
buf EplChar* Buffer into which the value of the registry entry is written.
buflen EplSize Buffer size. The buffer must be sufficiently dimensioned (s.a.).

eplSetEplanSetting

EplHandle
eplSetEplanSetting(const EplChar* section,
                   const EplChar* key,
                   const Eplchar* value);

eplDeleteEplanSetting

EplHandle
eplDeleteEplanSetting(const EplChar* section,
                      const EplChar* key);