setting_type Struct Reference

A setting type. More...

#include <settings.h>

Data Fields
const char *	name
	Name.
int(*	storef )(struct settings *settings, struct setting *setting, const char *value)
	Parse and set value of setting.
int(*	fetchf )(struct settings *settings, struct setting *setting, char *buf, size_t len)
	Fetch and format value of setting.

---

Detailed Description

A setting type.

This represents a type of setting (e.g. string, IPv4 address, etc.).

Definition at line 108 of file settings.h.

---

Field Documentation

const char* setting_type::name

Name.

This is the name exposed to the user (e.g. "string").

Definition at line 113 of file settings.h.

Referenced by find_setting_type().

int( * setting_type::storef)(struct settings *settings, struct setting *setting, const char *value)

Parse and set value of setting.

Parameters:

	settings	Settings block
	setting	Setting to store
	value	Formatted setting data

Return values:

rc

Return status code

Referenced by storef_setting().

int( * setting_type::fetchf)(struct settings *settings, struct setting *setting, char *buf, size_t len)

Fetch and format value of setting.

Parameters:

	settings	Settings block
	setting	Setting to fetch
	buf	Buffer to contain formatted value
	len	Length of buffer

Return values:

len

Length of formatted value, or negative error

Referenced by fetchf_setting().

---

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

• include/gpxe/settings.h