Lua:Neutrino-API:checkVersion:de: Unterschied zwischen den Versionen

Aus TuxBoxWIKI
Zur Navigation springen Zur Suche springen
K (Kommentare im Beispiel wiederhergestellt.)
(Update API 1.4)
Zeile 2: Zeile 2:


{{Lua_API_Funktion1Vers|Überprüft die Korrektheit der übergebenen LUA-API Version.<br />
{{Lua_API_Funktion1Vers|Überprüft die Korrektheit der übergebenen LUA-API Version.<br />
Ist die vorhandene API Version OK, wird 1 zurückgegeben, ist sie zu alt, wird eine Fehlermeldung ausgegeben und 0 zurückgegeben. Das Script sollte dann beendet werden (siehe Beispiel).|checkVersion|(Parameter)|1.0|00dff2c5985261b19cc54b2850f776b136b0f6af}}
Ist die vorhandene API Version zu alt, wird eine Fehlermeldung ausgegeben und das Plugin beendet.|checkVersion|(Parameter)|1.4|1e76cac3bad4083af7fc3acd62eef27a5b9d786b}}
{{Lua_API_Funktion_Param_Kopf}}
{{Lua_API_Funktion_Param_Kopf}}
{{Lua_API_Funktion_Param_Zeile0|1|number|major|Major Version}}
{{Lua_API_Funktion_Param_Zeile0|1|number|major|Major Version}}
Zeile 8: Zeile 8:
{{Lua_API_Funktion_Param_Fuss}}
{{Lua_API_Funktion_Param_Fuss}}


'''Rückgabewert:'''
{| border="1" cellpadding="4" cellspacing="0" style="background-color: #F4F4F4;"
|0
|Version zu alt, Script sollte beendet werden
|-
|1
|Version OK
|}
<br />


{{Lua API Funktion Beispiel2_Kopf}}
{{Lua API Funktion Beispiel2_Kopf}}
<source lang="lua">
<source lang="lua">
  -- Beispiel: Die erforderliche API Version ist 1.1
  -- Beispiel: Die erforderliche API Version ist 1.1
  -- Wenn die vorhandene Version älter ist, wird 0 zurückgegeben und das Script wird beendet.
  -- Wenn die vorhandene Version älter ist, wird eine Fehlermeldung ausgegeben und das Plugin beendet.
-- 'do return end' deshalb, da os.exit(0) das übergeordnete Programm beendet. Bei einem normalen
-- LUA Script ist das der LUA Interpreter, bei einem LUA Plugin wäre das aber Neutrino, was beendet wird!


  -- Ganz am Anfang des Scripts, außerhalb von irgendwelchen Funktionen, einfügen.
  -- Ganz am Anfang des Scripts einfügen.


local n = neutrino()
local n = neutrino()
local v = n:checkVersion(1, 1)
n:checkVersion(1, 1)
if (v == 0) then do return end end
</source>
</source>



Version vom 17. September 2015, 14:13 Uhr

checkVersion

Überprüft die Korrektheit der übergebenen LUA-API Version.
Ist die vorhandene API Version zu alt, wird eine Fehlermeldung ausgegeben und das Plugin beendet.

checkVersion(Parameter) ab API v1.4   -   Neutrino Git


Parameter:

Parameter Typ Description/Beschreibung
1 number major Major Version
2 number minor Minor Version
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.



Example:

 -- Beispiel: Die erforderliche API Version ist 1.1
 -- Wenn die vorhandene Version älter ist, wird eine Fehlermeldung ausgegeben und das Plugin beendet.

 -- Ganz am Anfang des Scripts einfügen.

local n = neutrino()
n:checkVersion(1, 1)