Type definition for a config item. More...
#include "set.h"
Data Fields | |
int | type |
Data type, e.g. DT_STRING. More... | |
const char * | name |
Name of the type, e.g. "String". More... | |
int(* | string_set )(const struct ConfigSet *cs, void *var, struct ConfigDef *cdef, const char *value, struct Buffer *err) |
Set a config item by string. More... | |
int(* | string_get )(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, struct Buffer *result) |
Get a config item as a string. More... | |
int(* | native_set )(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, intptr_t value, struct Buffer *err) |
Set a config item by string. More... | |
intptr_t(* | native_get )(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, struct Buffer *err) |
Get a string from a config item. More... | |
int(* | string_plus_equals )(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, const char *value, struct Buffer *err) |
Add to a config item by string. More... | |
int(* | string_minus_equals )(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, const char *value, struct Buffer *err) |
Remove from a config item as a string. More... | |
int(* | reset )(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, struct Buffer *err) |
Reset a config item to its initial value. More... | |
void(* | destroy )(const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef) |
Destroy a config item. More... | |
Type definition for a config item.
Each config item has a type which is defined by a set of callback functions.
const char* ConfigSetType::name |
int(* ConfigSetType::string_set) (const struct ConfigSet *cs, void *var, struct ConfigDef *cdef, const char *value, struct Buffer *err) |
Set a config item by string.
cs | Config items |
var | Variable to set (may be NULL) |
cdef | Variable definition |
value | Value to set (may be NULL) |
err | Buffer for error messages (may be NULL) |
num | Result, e.g. CSR_SUCCESS |
If var is NULL, then the config item's initial value will be set.
Contract
int(* ConfigSetType::string_get) (const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, struct Buffer *result) |
Get a config item as a string.
cs | Config items |
var | Variable to get (may be NULL) |
cdef | Variable definition |
result | Buffer for results or error messages |
num | Result, e.g. CSR_SUCCESS |
If var is NULL, then the config item's initial value will be returned.
Contract
int(* ConfigSetType::native_set) (const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, intptr_t value, struct Buffer *err) |
Set a config item by string.
cs | Config items |
var | Variable to set |
cdef | Variable definition |
value | Native pointer/value to set |
err | Buffer for error messages (may be NULL) |
num | Result, e.g. CSR_SUCCESS |
Contract
int(* ConfigSetType::string_plus_equals) (const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, const char *value, struct Buffer *err) |
Add to a config item by string.
cs | Config items |
var | Variable to set |
cdef | Variable definition |
value | Value to set |
err | Buffer for error messages (may be NULL) |
num | Result, e.g. CSR_SUCCESS |
Contract
int(* ConfigSetType::string_minus_equals) (const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, const char *value, struct Buffer *err) |
Remove from a config item as a string.
cs | Config items |
var | Variable to set |
cdef | Variable definition |
value | Value to set |
err | Buffer for error messages (may be NULL) |
num | Result, e.g. CSR_SUCCESS |
Contract
int(* ConfigSetType::reset) (const struct ConfigSet *cs, void *var, const struct ConfigDef *cdef, struct Buffer *err) |
Reset a config item to its initial value.
cs | Config items |
var | Variable to reset |
cdef | Variable definition |
err | Buffer for error messages (may be NULL) |
num | Result, e.g. CSR_SUCCESS |
Contract