settings_operations Struct Reference

Settings block operations. More...

#include <settings.h>

Data Fields
struct settings *(*	redirect )(struct settings *settings)
	Redirect to underlying settings block (if applicable) More...
int(*	applies )(struct settings *settings, const struct setting *setting)
	Check applicability of setting. More...
int(*	store )(struct settings *settings, const struct setting *setting, const void *data, size_t len)
	Store value of setting. More...
int(*	fetch )(struct settings *settings, struct setting *setting, void *data, size_t len)
	Fetch value of setting. More...
void(*	clear )(struct settings *settings)
	Clear settings block. More...

Detailed Description

Settings block operations.

Definition at line 85 of file settings.h.

Field Documentation

redirect

struct settings*( * settings_operations::redirect) (struct settings *settings)

Redirect to underlying settings block (if applicable)

Parameters

settings

Settings block

Return values

settings

Underlying settings block

Definition at line 91 of file settings.h.

Referenced by settings_target().

applies

int( * settings_operations::applies) (struct settings *settings, const struct setting *setting)

Check applicability of setting.

Parameters

settings	Settings block
setting	Setting

Return values

applies

Setting applies within this settings block

Definition at line 98 of file settings.h.

Referenced by setting_applies().

store

int( * settings_operations::store) (struct settings *settings, const 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

Definition at line 108 of file settings.h.

Referenced by store_setting().

fetch

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.

Definition at line 122 of file settings.h.

Referenced by fetch_setting().

clear

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

Clear settings block.

Parameters

settings

Settings block

Definition at line 128 of file settings.h.

Referenced by clear_settings().

---

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

• include/ipxe/settings.h