iPXE
Data Fields
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)
int(* applies )(struct settings *settings, const struct setting *setting)
 Check applicability of setting.
int(* store )(struct settings *settings, const 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 85 of file settings.h.


Field Documentation

Redirect to underlying settings block (if applicable)

Parameters:
settingsSettings block
Return values:
settingsUnderlying settings block

Definition at line 91 of file settings.h.

Referenced by settings_target().

Check applicability of setting.

Parameters:
settingsSettings block
settingSetting
Return values:
appliesSetting applies within this settings block

Definition at line 98 of file settings.h.

Referenced by setting_applies().

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

Store value of setting.

Parameters:
settingsSettings block
settingSetting to store
dataSetting data, or NULL to clear setting
lenLength of setting data
Return values:
rcReturn status code

Definition at line 108 of file settings.h.

Referenced by store_setting().

Fetch value of setting.

Parameters:
settingsSettings block
settingSetting to fetch
dataBuffer to fill with setting data
lenLength of buffer
Return values:
lenLength 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 settings block.

Parameters:
settingsSettings block

Definition at line 128 of file settings.h.

Referenced by clear_settings().


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