setting Struct Reference

A setting. More...

#include <settings.h>

Data Fields
const char *	name
	Name.
const char *	description
	Description.
const struct setting_type *	type
	Setting type.
uint64_t	tag
	Setting tag, if applicable.
const struct settings_scope *	scope
	Setting scope (or NULL)

Detailed Description

A setting.

Definition at line 24 of file settings.h.

Field Documentation

name

const char* setting::name

Name.

This is the human-readable name for the setting.

Definition at line 29 of file settings.h.

Referenced by choose_exec(), dhcp_create_request(), draw_info_row(), draw_setting_row(), edit_setting(), efi_snp_hii_extract_config(), efi_snp_hii_fetch(), efi_snp_hii_questions(), efi_snp_hii_store(), efivars_fetch(), find_setting(), generic_settings_store(), guestinfo_fetch_type(), inc_exec(), main_loop(), parse_kv(), parse_setting_name(), pciscan_exec(), phantom_clp_setting(), phantom_fetch_setting(), phantom_store_setting(), save_setting(), set_core_exec(), setting_cmp(), setting_name(), show_exec(), and usbscan_exec().

description

const char* setting::description

Description.

Definition at line 31 of file settings.h.

Referenced by draw_info_row(), and efi_snp_hii_questions().

type

const struct setting_type* setting::type

Setting type.

This identifies the type of setting (e.g. string, IPv4 address, etc.).

Definition at line 37 of file settings.h.

Referenced by acpi_settings_fetch(), choose_exec(), cpuid_settings_fetch(), efi_path_fetch(), efi_path_fetch_dns(), efivars_fetch(), fetchf_setting(), fetchn_setting(), generic_settings_fetch(), guestinfo_fetch_type(), inc_exec(), lldp_fetch(), memmap_settings_fetch(), ndp_fetch(), nslookup_resolv_done(), parse_setting_name(), pci_settings_fetch(), pciscan_exec(), set_core_exec(), setting_name(), smbios_fetch(), storef_setting(), storen_setting(), usb_settings_fetch(), and usbscan_exec().

tag

uint64_t setting::tag

Setting tag, if applicable.

The setting tag is a numerical description of the setting (such as a DHCP option number, or an SMBIOS structure and field number).

Definition at line 44 of file settings.h.

Referenced by acpi_settings_fetch(), copy_encap_settings(), cpuid_settings_fetch(), dhcp_create_request(), dhcppkt_settings_applies(), dhcppkt_settings_fetch(), dhcppkt_settings_store(), dhcpv6_fetch(), efi_snp_hii_questions(), lldp_fetch(), memmap_settings_fetch(), ndp_fetch(), nvo_applies(), nvo_fetch(), nvo_store(), parse_setting_name(), pci_settings_fetch(), phantom_clp_setting(), setting_cmp(), smbios_fetch(), and usb_settings_fetch().

scope

const struct settings_scope* setting::scope

Setting scope (or NULL)

For historic reasons, a NULL scope with a non-zero tag indicates a DHCPv4 option setting.

Definition at line 50 of file settings.h.

Referenced by acpi_settings_applies(), builtin_applies(), cpuid_settings_applies(), dhcppkt_settings_applies(), dhcpv6_applies(), efivars_applies(), ipv6_applies(), lldp_applies(), memmap_settings_applies(), ndp_applies(), ndp_prefix_applies(), nvo_applies(), parse_setting_name(), pci_settings_applies(), phantom_clp_setting(), setting_cmp(), smbios_applies(), and usb_settings_applies().

---

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

• include/ipxe/settings.h