Registry - Revision history

WikiSysop: /* :SetInt(string parameter_name, integer value) */

2024-10-11T21:49:51Z

:SetInt(string parameter_name, integer value)

← Older revision		Revision as of 15:49, 11 October 2024
Line 61:		Line 61:
	::''value (integer) the value which will be stored in the parameter list''		::''value (integer) the value which will be stored in the parameter list''

			'''''Sample Code:'''''
			<nowiki>
			RegistryWrite:SetInt("JimAndI.Count", JimAndI.Count)
			</nowiki>

	===:StringExists(string parameter_name)===		===:StringExists(string parameter_name)===

WikiSysop: /* :GetInt(string parameter_name, integer default_value) */

2024-10-11T21:48:38Z

:GetInt(string parameter_name, integer default_value)

← Older revision		Revision as of 15:48, 11 October 2024
Line 50:		Line 50:
	::''parameter_name (string) the name of the parameter''		::''parameter_name (string) the name of the parameter''
	::''value (integer) the value which will be returned if there is no existing value stored''		::''value (integer) the value which will be returned if there is no existing value stored''
	'''''Sample Code:'''''
			'''''Sample Code:'''''
	<nowiki>		<nowiki>
	JimAndI.Count = RegistryRead:GetInt("JimAndI.Count", 2)		JimAndI.Count = RegistryRead:GetInt("JimAndI.Count", 2)

WikiSysop: /* :GetInt(string parameter_name, integer default_value) */

2024-10-11T21:48:09Z

:GetInt(string parameter_name, integer default_value)

← Older revision		Revision as of 15:48, 11 October 2024
Line 50:		Line 50:
	::''parameter_name (string) the name of the parameter''		::''parameter_name (string) the name of the parameter''
	::''value (integer) the value which will be returned if there is no existing value stored''		::''value (integer) the value which will be returned if there is no existing value stored''
			'''''Sample Code:'''''
	<nowiki>		<nowiki>
	JimAndI.Count = RegistryRead:GetInt("JimAndI.Count", 2)		JimAndI.Count = RegistryRead:GetInt("JimAndI.Count", 2)

WikiSysop: /* :GetInt(string parameter_name, integer default_value) */

2024-10-11T21:47:21Z

:GetInt(string parameter_name, integer default_value)

← Older revision		Revision as of 15:47, 11 October 2024
Line 50:		Line 50:
	::''parameter_name (string) the name of the parameter''		::''parameter_name (string) the name of the parameter''
	::''value (integer) the value which will be returned if there is no existing value stored''		::''value (integer) the value which will be returned if there is no existing value stored''
			<nowiki>
			JimAndI.Count = RegistryRead:GetInt("JimAndI.Count", 2)
			</nowiki>

	===:SetInt(string parameter_name, integer value)===		===:SetInt(string parameter_name, integer value)===

WikiSysop at 00:49, 2 May 2024

2024-05-02T00:49:38Z

WikiSysop: /* References */

2021-08-04T15:21:02Z

References

← Older revision		Revision as of 09:21, 4 August 2021
Line 90:		Line 90:

	==References==		==References==
	'''Please Note:''' The base material for the contents found in this WiKi was sourced from Vectric Lua Interface for Gadgets, version 2.05, published ~~September 12~~, ~~2018~~. by Vectric Ltd. Most current document from Vertric can be downloaded at [https://gadgets.vectric.com/developerinfo.html Vertric Developer Information]		'''Please Note:''' The base material for the contents found in this WiKi was sourced from Vectric Lua Interface for Gadgets, version 10.0, published August 21, 2019. by Vectric Ltd. Most current document from Vertric can be downloaded at [https://gadgets.vectric.com/developerinfo.html Vertric Developer Information]

WikiSysop: Created page with "link=User Interface Category:SDK This object is used to save and load values from the registry. This allows gadgets to persist settings across..."

2021-08-04T04:17:04Z

Created page with "right|50px|link=User Interface Category:SDK This object is used to save and load values from the registry. This allows gadgets to persist settings across..."

New page

[[File:Back.jpg|right|50px|link=User Interface]]
[[Category:SDK]]
This object is used to save and load values from the registry. This allows gadgets to persist settings across different runs of the gadget. All the values are stored under a single <q>section</q> in the registry, so it is important that each gadget uses a unique name for its section. The sections are unique to each product, so the same gadget run under both Aspire and VCarve Pro will store their settings in different areas.

==Constructor==

===Registry(string section_name)===
Create a new object used for reading and writing values
Section_name (string) Name of section in registry to store all values under
::''local dir_reader = DirectoryReader("MyGadget")''

==Methods==

===:BoolExists(string parameter_name)===
'''Returns:''' (bool) true if there is an existing bool parameter with passed name

===:GetBool(string parameter_name, bool default_value)===
Retrieve a bool with the passed name, if no value with passed name returns the passed default value
::''parameter_name (string) the name of the parameter ''
::''value (integer) the value which will be returned if there is no existing value stored''

===:SetBool(string parameter_name, bool default_value)===
Retrieve a Boolean flag (true or false) with the passed name, if no value with passed name returns the passed default value
::''parameter_name (string) the name of the parameter''
::''default_value(bool) the value which will be returned if there is no existing value stored''

===:DoubleExists(string parameter_name)===
'''Returns:''' (bool) true if there is an existing double parameter with passed name

===:GetDouble(string parameter_name, double default_value)===
Retrieve a double with the passed name, if no value with passed name returns the passed default value
::''parameter_name (string) the name of the parameter default_value(double) the value which will be returned if there is no existing value stored''

===:SetDouble(string parameter_name, double value)===
Store a double with the passed name and value
::''parameter_name (string) the name which will be used to store and retrieve the value''
::''value(double) the value which will be stored in the parameter list''

===:IntExists(string parameter_name)===
'''Returns:''' (bool) true if there is an existing int parameter with passed name

===:GetInt(string parameter_name, integer default_value)===
Retrieve an integer with the passed name, if no value with passed name returns the passed default value
::''parameter_name (string) the name of the parameter''
::''value (integer) the value which will be returned if there is no existing value stored''

===:SetInt(string parameter_name, integer value)===
Store an integer with the passed name and value
::''parameter_name (string) the name which will be used to store and retrieve the value''
::''value (integer) the value which will be stored in the parameter list''

===:StringExists(string parameter_name)===
'''Returns:''' (bool) true if there is an existing string parameter with passed name

===:GetString(string parameter_name, string value)===
Retrieve a string with the passed name , if no value with passed name returns the passed default value
::''parameter_name (string) the name of the parameter''
::''value (string) the value which will be returned if there is no existing value stored''

===:SetString(string parameter_name, string value)===
Store a string with the passed name and value
::''parameter_name (string) the name which will be used to store and retrieve the value''
::''value (string) the value which will be stored in the parameter list''

'''''Sample Code:'''''
<nowiki> function ReadRegistry() -- Read from Registry values
local RegistryRead = Registry("MyProgram")
if not(RegistryRead:StringExists("CodeBy")) then
LoadRegistry()
end
CodeBy = RegistryRead:GetString("CodeBy", "James Anderson")
ProgramName = RegistryRead:GetString("ProgramName", "Easy Dovetail Maker")
ProgramVersion = RegistryRead:GetString("ProgramVersion", Dovetail.ProgramVersion)
ProgramYear = RegistryRead:GetString("ProgramYear", "2020")
end </nowiki>

[[File:Back.jpg|right|50px|link=User Interface]]

==References==
'''Please Note:''' The base material for the contents found in this WiKi was sourced from Vectric Lua Interface for Gadgets, version 2.05, published September 12, 2018. by Vectric Ltd. Most current document from Vertric can be downloaded at [https://gadgets.vectric.com/developerinfo.html Vertric Developer Information]

← Older revision		Revision as of 18:49, 1 May 2024
Line 17:		Line 17:

	===:BoolExists(string parameter_name)===		===:BoolExists(string parameter_name)===
	'''Returns:''' (bool) true if there is an existing bool parameter with passed name		'''Returns:''' (bool) true if there is an existing bool parameter with passed name

	===:GetBool(string parameter_name, bool default_value)===		===:GetBool(string parameter_name, bool default_value)===
Line 31:		Line 31:

	===:DoubleExists(string parameter_name)===		===:DoubleExists(string parameter_name)===
	'''Returns:''' (bool) true if there is an existing double parameter with passed name		'''Returns:''' (bool) true if there is an existing double parameter with passed name

	===:GetDouble(string parameter_name, double default_value)===		===:GetDouble(string parameter_name, double default_value)===
Line 44:		Line 44:

	===:IntExists(string parameter_name)===		===:IntExists(string parameter_name)===
	'''Returns:''' (bool) true if there is an existing int parameter with passed name		'''Returns:''' (bool) true if there is an existing int parameter with passed name

	===:GetInt(string parameter_name, integer default_value)===		===:GetInt(string parameter_name, integer default_value)===
Line 58:		Line 58:

	===:StringExists(string parameter_name)===		===:StringExists(string parameter_name)===
	'''Returns:''' (bool) true if there is an existing string parameter with passed name		'''Returns:''' (bool) true if there is an existing string parameter with passed name