settings_operations Struct Reference

Settings block operations. More...

#include <settings.h>

Data Fields
int(*	store )(struct settings *settings, struct setting *setting, const void *data, size_t len)
	Store value of setting.
int(*	fetch )(struct settings *settings, struct setting *setting, void *data, size_t len)
	Fetch value of setting.
void(*	clear )(struct settings *settings)
	Clear settings block.

---

Detailed Description

Settings block operations.

Definition at line 47 of file settings.h.

---

Field Documentation

int( * settings_operations::store)(struct settings *settings, struct setting *setting, const void *data, size_t len)

Store value of setting.

Parameters:

	settings	Settings block
	setting	Setting to store
	data	Setting data, or NULL to clear setting
	len	Length of setting data

Return values:

rc

Return status code

Referenced by store_setting().

int( * settings_operations::fetch)(struct settings *settings, struct setting *setting, void *data, size_t len)

Fetch value of setting.

Parameters:

	settings	Settings block
	setting	Setting to fetch
	data	Buffer to fill with setting data
	len	Length of buffer

Return values:

len

Length of setting data, or negative error

The actual length of the setting will be returned even if the buffer was too small.

Referenced by fetch_setting().

void( * settings_operations::clear)(struct settings *settings)

Clear settings block.

Parameters:

settings

Settings block

Referenced by clear_settings().

---

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

• include/gpxe/settings.h