Lua:Neutrino-API:configfile:de

Aus TuxBoxWIKI
Version vom 14. September 2016, 08:34 Uhr von Dbt (Diskussion | Beiträge) (Kategorie angepasst)
(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
Zur Navigation springen Zur Suche springen

configfile

Die configfile Funktionen ermöglichen das Lesen und Schreiben von Konfigurationsdateien. Die einzelnen Funktionen und Parameter entsprechen denen in Neutrino. Das Format der Konfigurationsdatei entspricht zB: dem der neutrino.conf.


Erzeugt eine configfile Instanz

configfile.new{}


loadConfig

Lädt die angegebene Konfigurationsdatei

configfile:loadConfig{Parameter}


Parameter:

Parameter Typ Description/Beschreibung
1 string Vollständiger Pfad und Dateiname der Konfigurationsdatei
en: Parameters with default-values are optional. If not needed, no definition is required. In case of missing parameter, default value is used.

de: Parameter mit Default-Wert sind optional. dh. sie müssen nicht angegeben werden. Falls der Parameter fehlt, wird automatisch dieser Wert angenommen.


saveConfig

Speichert die angegebene Konfigurationsdatei

configfile:saveConfig{Parameter}


Parameter:

Parameter Typ Description/Beschreibung
1 string Vollständiger Pfad und Dateiname der Konfigurationsdatei
en: Parameters with default-values are optional. If not needed, no definition is required. In case of missing parameter, default value is used.

de: Parameter mit Default-Wert sind optional. dh. sie müssen nicht angegeben werden. Falls der Parameter fehlt, wird automatisch dieser Wert angenommen.


getString

Liest einen Stringparameter aus der Config

configfile:getString{Parameter}


Parameter:

Parameter Typ Description/Beschreibung
1 string Name des Parameters
2 string Defaultwert des Parameters Optional, default: ""
 
Rückgabewert: string Wert des Parameters
en: Parameters with default-values are optional. If not needed, no definition is required. In case of missing parameter, default value is used.

de: Parameter mit Default-Wert sind optional. dh. sie müssen nicht angegeben werden. Falls der Parameter fehlt, wird automatisch dieser Wert angenommen.


setString

Setzt einen Stringparameter in der Config

configfile:setString{Parameter}


Parameter:

Parameter Typ Description/Beschreibung
1 string Name des Parameters
2 string Wert des Parameters
en: Parameters with default-values are optional. If not needed, no definition is required. In case of missing parameter, default value is used.

de: Parameter mit Default-Wert sind optional. dh. sie müssen nicht angegeben werden. Falls der Parameter fehlt, wird automatisch dieser Wert angenommen.


getInt32

Liest einen int32 Parameter aus der Config

configfile:getInt32{Parameter}


Parameter:

Parameter Typ Description/Beschreibung
1 string Name des Parameters
2 number Defaultwert des Parameters Optional, default: 0
 
Rückgabewert: number Wert des Parameters
en: Parameters with default-values are optional. If not needed, no definition is required. In case of missing parameter, default value is used.

de: Parameter mit Default-Wert sind optional. dh. sie müssen nicht angegeben werden. Falls der Parameter fehlt, wird automatisch dieser Wert angenommen.


setInt32

Setzt einen Stringparameter in der Config

configfile:setInt32{Parameter}


Parameter:

Parameter Typ Description/Beschreibung
1 string Name des Parameters
2 number Wert des Parameters
en: Parameters with default-values are optional. If not needed, no definition is required. In case of missing parameter, default value is used.

de: Parameter mit Default-Wert sind optional. dh. sie müssen nicht angegeben werden. Falls der Parameter fehlt, wird automatisch dieser Wert angenommen.


getBool

Liest einen Boolean Parameter aus der Config

configfile:getBool{Parameter}


Parameter:

Parameter Typ Description/Beschreibung
1 string Name des Parameters
2 bool Defaultwert des Parameters Optional, default: false
 
Rückgabewert: bool Wert des Parameters
en: Parameters with default-values are optional. If not needed, no definition is required. In case of missing parameter, default value is used.

de: Parameter mit Default-Wert sind optional. dh. sie müssen nicht angegeben werden. Falls der Parameter fehlt, wird automatisch dieser Wert angenommen.


setBool

Setzt einen Stringparameter in der Config

configfile:setBool{Parameter}


Parameter:

Parameter Typ Description/Beschreibung
1 string Name des Parameters
2 bool Wert des Parameters
en: Parameters with default-values are optional. If not needed, no definition is required. In case of missing parameter, default value is used.

de: Parameter mit Default-Wert sind optional. dh. sie müssen nicht angegeben werden. Falls der Parameter fehlt, wird automatisch dieser Wert angenommen.


Funktionsbeispiel

Example:

local posix	= require "posix"
confFile	= "/var/tuxbox/config/test.conf";
config		= configfile.new()
configChanged	= 0

function loadConfig()
	config:loadConfig(confFile)

	conf["language"] = config:getString("language", "DE")
	conf["quality"]  = config:getString("quality",  "max")
end

function saveConfig()
	if configChanged == 1 then
		local h = hintbox.new{caption="Info", text="Einstellungen werden gespeichert...", icon="info"};
		h:paint();

		config:setString("language", conf["language"])
		config:setString("quality",  conf["quality"])

		config:saveConfig(confFile)

		configChanged = 0
		posix.sleep(1)
		h:hide();
	end
end


Abgerufen von „https://wiki.tuxbox-neutrino.org/w/index.php?title=Lua:Neutrino-API:configfile:de&oldid=17335“