Repository.Variable.UpdateVariable - Revision history

Kate Racaza at 17:42, 9 June 2016

2016-06-09T17:42:12Z

← Older revision		Revision as of 17:42, 9 June 2016
Line 2:		Line 2:


	<onlyinclude>~~Sends any changes made to an existing~~ variable resource to the ~~Synthesis repository~~. Returns a '''Boolean''' value; when true, indicates a successful ~~save~~.</onlyinclude>		<onlyinclude>Updates the properties of a given variable resource in the current project. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude>

	== Syntax ==		== Syntax ==
Line 9:		Line 9:
	=== Parameters ===		=== Parameters ===
	''var''		''var''
	: Required. The [[CVariable Class\|cVariable]] object to be updated.		: Required. The [[CVariable Class\|cVariable]] object that represents the variable resource to be updated.

Kate Racaza at 18:45, 8 April 2016

2016-04-08T18:45:43Z

← Older revision		Revision as of 18:45, 8 April 2016
Line 2:		Line 2:


	<onlyinclude>~~Applies~~ any changes made to an existing variable resource. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>		<onlyinclude>Sends any changes made to an existing variable resource to the Synthesis repository. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>

	== Syntax ==		== Syntax ==
Line 17:		Line 17:
	'''VBA'''		'''VBA'''

	{{APIComment\|'~~Add code to~~ connect to a Synthesis repository.}}		{{APIComment\|'Declare a new Repository object and connect to a Synthesis repository.}}
	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	{{~~APIComment~~\|...}}		MyRepository.ConnectToAccessRepository({{APIString\|"C:\RSRepository1.rsr10"}})


	{{APIComment\|'Get variable #1 from project #1.}}		{{APIComment\|'Get variable #1 from project #1.}}
	{{APIPrefix\|Dim}} MyVariable {{APIPrefix\|As}} cVariable		{{APIPrefix\|Dim}} MyVariable {{APIPrefix\|As}} cVariable
	MyRepository.Project.SetCurrentProject(1)		MyRepository.Project.SetCurrentProject(1)
	{{APIPrefix\|Set}} MyVariable = MyRepository.Variable.GetVariable(1)		{{APIPrefix\|Set}} MyVariable = MyRepository.Variable.GetVariable(1)

	{{APIComment\|'Change the variable's name to "New_Name."}}		{{APIComment\|'Change the variable's name to "New_Name."}}
	MyVariable.Name = {{APIString\|"New_Name"}}		MyVariable.Name = {{APIString\|"New_Name"}}

	{{APIComment\|'~~Apply~~ the change to ~~the variable. Changes are recorded in~~ the Synthesis repository.}}		{{APIComment\|'Send the change to the Synthesis repository.}}
	{{APIPrefix\|Call}} MyRepository.Variable.UpdateVariable(MyVariable)		{{APIPrefix\|Call}} MyRepository.Variable.UpdateVariable(MyVariable)

	'''VB.NET'''		'''VB.NET'''

	{{APIComment\|'~~Add code to~~ connect to a Synthesis repository.}}		{{APIComment\|'Declare a new Repository object and connect to a Synthesis repository.}}
	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	{{~~APIComment~~\|...}}		MyRepository.ConnectToAccessRepository({{APIString\|"C:\RSRepository1.rsr10"}})


	{{APIComment\|'Get variable #1 from project #1.}}		{{APIComment\|'Get variable #1 from project #1.}}
	{{APIPrefix\|Dim}} MyVariable {{APIPrefix\|As}} cVariable		{{APIPrefix\|Dim}} MyVariable {{APIPrefix\|As}} cVariable
	MyRepository.Project.SetCurrentProject(1)		MyRepository.Project.SetCurrentProject(1)
	MyVariable = MyRepository.Variable.GetVariable(1)		MyVariable = MyRepository.Variable.GetVariable(1)

	{{APIComment\|'Change the variable's name to "New_Name."}}		{{APIComment\|'Change the variable's name to "New_Name."}}
	MyVariable.Name = {{APIString\|"New_Name"}}		MyVariable.Name = {{APIString\|"New_Name"}}

	{{APIComment\|'~~Apply~~ the change to ~~the variable. Changes are recorded in~~ the Synthesis repository.}}		{{APIComment\|'Send the change to the Synthesis repository.}}
	MyRepository.Variable.UpdateVariable(MyVariable)		MyRepository.Variable.UpdateVariable(MyVariable)

Kate Racaza at 22:22, 13 November 2015

2015-11-13T22:22:09Z

← Older revision		Revision as of 22:22, 13 November 2015
Line 1:		Line 1:
	{{Template:API}}{{Template:APIBreadcrumb~~\|10~~\|.[[Repository Class\|Repository]]}}		{{Template:API}}{{Template:APIBreadcrumb\|.[[Repository Class\|Repository]]}}

Kate Racaza at 20:56, 24 August 2015

2015-08-24T20:56:01Z

← Older revision		Revision as of 20:56, 24 August 2015
Line 13:		Line 13:

	== Example ==		== Example ==
	This example assumes that a variable with ID #1 exists in the first available project in a repository.		This example assumes that a variable with ID #1 exists in the first available project of a repository.

	'''VBA'''		'''VBA'''

Kate Racaza at 20:54, 24 August 2015

2015-08-24T20:54:49Z

← Older revision		Revision as of 20:54, 24 August 2015
Line 1:		Line 1:
	{{Template:API}}{{Template:APIBreadcrumb\|10\|.[[Repository Class\|Repository]]}}		{{Template:API}}{{Template:APIBreadcrumb\|10\|.[[Repository Class\|Repository]]}}

	<onlyinclude>~~Updates the properties of~~ an existing variable ~~in the current project. Changes are reflected in the repository immediately upon refresh~~. Returns a '''Boolean''' value; when true, indicates a successful ~~update~~.</onlyinclude>
			<onlyinclude>Applies any changes made to an existing variable resource. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>

	== Syntax ==		== Syntax ==
	'''.Variable.UpdateVariable'''(''var'')		'''.Variable.UpdateVariable'''(''var'')

	=== Parameters ===		=== Parameters ===
	''var''		''var''
	:The [[CVariable Class\|cVariable]] object to be updated.		: Required. The [[CVariable Class\|cVariable]] object to be updated.


	== Example ==		== Example ==
	This example assumes that a variable with ID#1 exists in the repository.		This example assumes that a variable with ID #1 exists in the first available project in a repository.

	'''VBA'''		'''VBA'''
Line 28:		Line 30:
	MyVariable.Name = {{APIString\|"New_Name"}}		MyVariable.Name = {{APIString\|"New_Name"}}

	{{APIComment\|'Apply the ~~update~~ to the variable. Changes ~~will be reflected~~ in the repository.}}		{{APIComment\|'Apply the change to the variable. Changes are recorded in the Synthesis repository.}}
	{{APIPrefix\|Call}} MyRepository.Variable.UpdateVariable(MyVariable)		{{APIPrefix\|Call}} MyRepository.Variable.UpdateVariable(MyVariable)

Line 46:		Line 48:
	MyVariable.Name = {{APIString\|"New_Name"}}		MyVariable.Name = {{APIString\|"New_Name"}}

	{{APIComment\|'Apply the ~~update~~ to the variable. Changes ~~will be reflected~~ in the repository.}}		{{APIComment\|'Apply the change to the variable. Changes are recorded in the Synthesis repository.}}
	MyRepository.Variable.UpdateVariable(MyVariable)		MyRepository.Variable.UpdateVariable(MyVariable)

Kate Racaza at 20:17, 21 July 2015

2015-07-21T20:17:35Z

← Older revision		Revision as of 20:17, 21 July 2015
Line 1:		Line 1:
	~~<noinclude>~~{{Template:API}}{{Template:APIBreadcrumb\|10\|.[[Repository Class\|Repository]]}}</~~noinclude~~>		{{Template:API}}{{Template:APIBreadcrumb\|10\|.[[Repository Class\|Repository]]}}

			<onlyinclude>Updates the properties of an existing variable in the current project. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude>

	Updates the properties of an existing variable in the current project. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.
	~~<noinclude>~~
	== Syntax ==		== Syntax ==
	'''.Variable.UpdateVariable'''(''var'')		'''.Variable.UpdateVariable'''(''var'')
Line 48:		Line 48:
	{{APIComment\|'Apply the update to the variable. Changes will be reflected in the repository.}}		{{APIComment\|'Apply the update to the variable. Changes will be reflected in the repository.}}
	MyRepository.Variable.UpdateVariable(MyVariable)		MyRepository.Variable.UpdateVariable(MyVariable)
	~~</noinclude>~~

Kate Racaza at 20:25, 20 July 2015

2015-07-20T20:25:08Z

← Older revision		Revision as of 20:25, 20 July 2015
Line 1:		Line 1:
	<noinclude>{{Template:API}}{{Template:APIBreadcrumb\|10\|[[Repository Class\|Repository]]}}</noinclude>		<noinclude>{{Template:API}}{{Template:APIBreadcrumb\|10\|.[[Repository Class\|Repository]]}}</noinclude>

	~~Saves all updates to a~~ variable. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.		Updates the properties of an existing variable in the current project. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.
	<noinclude>		<noinclude>
	== Syntax ==		== Syntax ==
	'~~'object~~''.'''~~Variable.UpdateVariable~~(''var'')~~'''~~		'''.Variable.UpdateVariable'''(''var'')

	~~where ''object'' is a variable that represents a Repository object.~~

	=== Parameters ===		=== Parameters ===
	~~{\| {{APITable}}~~		''var''
	\|-		:The [[CVariable Class\|cVariable]] object to be updated.
	~~\|var{{APIParam\|Required}}\|\|~~The [[CVariable Class\|cVariable]] object to be updated.
	\|}


Line 20:		Line 15:
	'''VBA'''		'''VBA'''

	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIComment\|'Add code to connect to a Synthesis repository.}}
	{{APIComment\|..~~.'Add code to connect to a Synthesis repository~~.}}		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
			{{APIComment\|...}}


	{{APIComment\|'Get variable #1 from project #1.}}		{{APIComment\|'Get variable #1 from project #1.}}
Line 36:		Line 33:
	'''VB.NET'''		'''VB.NET'''

	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIComment\|'Add code to connect to a Synthesis repository.}}
	{{APIComment\|..~~.'Add code to connect to a Synthesis repository~~.}}		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
			{{APIComment\|...}}


	{{APIComment\|'Get ~~URD~~ #1 from project #1.}}		{{APIComment\|'Get variable #1 from project #1.}}
	{{APIPrefix\|Dim}} ~~MyURD~~ {{APIPrefix\|As}} ~~cURD~~		{{APIPrefix\|Dim}} MyVariable {{APIPrefix\|As}} cVariable
	MyRepository.Project.SetCurrentProject(1)		MyRepository.Project.SetCurrentProject(1)
	~~MyURD~~ = MyRepository.~~URD~~.~~GetURD~~(1)		MyVariable = MyRepository.Variable.GetVariable(1)

	{{APIComment\|'Change the ~~URD~~'s name to "New_Name."}}		{{APIComment\|'Change the variable's name to "New_Name."}}
	~~MyURD~~.Name = {{APIString\|"New_Name"}}		MyVariable.Name = {{APIString\|"New_Name"}}

	{{APIComment\|'Apply the update to the ~~URD~~. Changes will be reflected in the repository.}}		{{APIComment\|'Apply the update to the variable. Changes will be reflected in the repository.}}
	MyRepository.~~URD~~.~~UpdateURD~~(~~MyURD~~)		MyRepository.Variable.UpdateVariable(MyVariable)
	</noinclude>		</noinclude>

Kate Racaza at 17:22, 17 July 2015

2015-07-17T17:22:00Z

← Older revision		Revision as of 17:22, 17 July 2015
Line 1:		Line 1:
	<noinclude>{{Template:API}}{{Template:APIBreadcrumb\|10\|Repository}}</noinclude>		<noinclude>{{Template:API}}{{Template:APIBreadcrumb\|10\|[[Repository Class\|Repository]]}}</noinclude>

	Saves all updates to a variable. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.		Saves all updates to a variable. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.

Kate Racaza at 21:54, 16 July 2015

2015-07-16T21:54:31Z

← Older revision		Revision as of 21:54, 16 July 2015
Line 1:		Line 1:
	{{Template:APIBreadcrumb\|10\|Repository}}		<noinclude>{{Template:API}}{{Template:APIBreadcrumb\|10\|Repository}}</noinclude>
	~~{{Template:API}}~~
	Saves all updates to a variable. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.		Saves all updates to a variable. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.
			<noinclude>
	== Syntax ==		== Syntax ==
	''object''.'''Variable.UpdateVariable(''var'')'''		''object''.'''Variable.UpdateVariable(''var'')'''
Line 11:		Line 11:
	{\| {{APITable}}		{\| {{APITable}}
	\|-		\|-
	\|var{{APIParam\|Required}}\|\|The ~~'''~~[[CVariable Class\|cVariable]]~~'''~~ object to be updated.		\|var{{APIParam\|Required}}\|\|The [[CVariable Class\|cVariable]] object to be updated.
	\|}		\|}

Line 28:		Line 28:
	{{APIPrefix\|Set}} MyVariable = MyRepository.Variable.GetVariable(1)		{{APIPrefix\|Set}} MyVariable = MyRepository.Variable.GetVariable(1)

	{{APIComment\|'Change the variable's name to "New_Name".}}		{{APIComment\|'Change the variable's name to "New_Name."}}
	MyVariable.Name = "New_Name"		MyVariable.Name = {{APIString\|"New_Name"}}

	{{APIComment\|'Apply the update to the variable. Changes will be reflected in the repository.}}		{{APIComment\|'Apply the update to the variable. Changes will be reflected in the repository.}}
Line 44:		Line 44:
	MyURD = MyRepository.URD.GetURD(1)		MyURD = MyRepository.URD.GetURD(1)

	{{APIComment\|'Change the URD's name to "New_Name".}}		{{APIComment\|'Change the URD's name to "New_Name."}}
	MyURD.Name = "New_Name"		MyURD.Name = {{APIString\|"New_Name"}}

	{{APIComment\|'Apply the update to the URD. Changes will be reflected in the repository.}}		{{APIComment\|'Apply the update to the URD. Changes will be reflected in the repository.}}
	MyRepository.URD.UpdateURD(MyURD)		MyRepository.URD.UpdateURD(MyURD)
			</noinclude>

Kate Racaza at 23:34, 14 July 2015

2015-07-14T23:34:20Z

← Older revision		Revision as of 23:34, 14 July 2015
Line 1:		Line 1:
	{{Template:~~APIClass~~\|~~Repository Class~~\|Repository}}		{{Template:APIBreadcrumb\|10\|Repository}}
	{{Template:~~Repository~~.~~UpdateVariable~~.~~Cmt}} {{Template:BooleanReturn~~.~~Cmt}}~~		{{Template:API}}
			Saves all updates to a variable. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.

	==Syntax==		== Syntax ==
	*UpdateVariable( var ~~{{APIPrefix\|As}}[[cVariable Class\|cVariable]]~~ )~~{{APIPrefix\|As Boolean}}~~		''object''.'''Variable.UpdateVariable(''var'')'''

	~~Parameters~~		where ''object'' is a variable that represents a Repository object.
	:''~~var~~''~~: The [[cVariable Class\|cVariable]] to update~~.

	== ~~Usage Example~~ ==		=== Parameters ===
	{{~~APIComment~~\|'~~Declare~~ a ~~new~~ repository ~~connection object~~.}}		{\| {{APITable}}
	Dim MyRepository As New Repository		\|-
			\|var{{APIParam\|Required}}\|\|The '''[[CVariable Class\|cVariable]]''' object to be updated.
			\|}


			== Example ==
			This example assumes that a variable with ID#1 exists in the repository.

			'''VBA'''

			{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
			{{APIComment\|...'Add code to connect to a Synthesis repository.}}

	{{APIComment\|'~~Connect to the Synthesis repository~~.}}		{{APIComment\|'Get variable #1 from project #1.}}
	Dim ~~Success~~ As ~~Boolean = False~~		{{APIPrefix\|Dim}} MyVariable {{APIPrefix\|As}} cVariable
	~~Success~~ = MyRepository.~~ConnectToRepository~~("~~RepositoryFileNamePath~~")		MyRepository.Project.SetCurrentProject(1)
			{{APIPrefix\|Set}} MyVariable = MyRepository.Variable.GetVariable(1)

			{{APIComment\|'Change the variable's name to "New_Name".}}
			MyVariable.Name = "New_Name"

			{{APIComment\|'Apply the update to the variable. Changes will be reflected in the repository.}}
			{{APIPrefix\|Call}} MyRepository.Variable.UpdateVariable(MyVariable)

			'''VB.NET'''

			{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
			{{APIComment\|...'Add code to connect to a Synthesis repository.}}

	{{APIComment\|'~~Set a first available~~ project ~~as current~~.}}		{{APIComment\|'Get URD #1 from project #1.}}
	MyRepository.Project.SetCurrentProject(0)		{{APIPrefix\|Dim}} MyURD {{APIPrefix\|As}} cURD
			MyRepository.Project.SetCurrentProject(1)
			MyURD = MyRepository.URD.GetURD(1)

	{{APIComment\|'~~Get~~ the ~~list of variables in the current project~~.}}		{{APIComment\|'Change the URD's name to "New_Name".}}
	~~Dim ListOfVariables() As [[cVariable Class\|cVariable]]~~		MyURD.Name = "New_Name"
	~~ListOfVariables~~= ~~MyRepository.Variable.GetAllVariables()~~
			{{APIComment\|'Apply the update to the URD. Changes will be reflected in the repository.}}
	{{APIComment\|'~~Update~~ the ~~variable and~~ update the repository.}}		MyRepository.URD.UpdateURD(MyURD)
	~~Dim SuccessUpdateVariable As Boolean~~
	~~SuccessUpdateVariable =~~ MyRepository.~~Variable~~.~~UpdateVariable(ListOfVariables~~(0))

← Older revision		Revision as of 18:45, 8 April 2016
Line 2:		Line 2:


	<onlyinclude>~~Applies~~ any changes made to an existing variable resource. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>		<onlyinclude>Sends any changes made to an existing variable resource to the Synthesis repository. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>

	== Syntax ==		== Syntax ==
Line 17:		Line 17:
	'''VBA'''		'''VBA'''

	{{APIComment\|'~~Add code to~~ connect to a Synthesis repository.}}		{{APIComment\|'Declare a new Repository object and connect to a Synthesis repository.}}
	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	{{~~APIComment~~\|...}}		MyRepository.ConnectToAccessRepository({{APIString\|"C:\RSRepository1.rsr10"}})


	{{APIComment\|'Get variable #1 from project #1.}}		{{APIComment\|'Get variable #1 from project #1.}}
	{{APIPrefix\|Dim}} MyVariable {{APIPrefix\|As}} cVariable		{{APIPrefix\|Dim}} MyVariable {{APIPrefix\|As}} cVariable
	MyRepository.Project.SetCurrentProject(1)		MyRepository.Project.SetCurrentProject(1)
	{{APIPrefix\|Set}} MyVariable = MyRepository.Variable.GetVariable(1)		{{APIPrefix\|Set}} MyVariable = MyRepository.Variable.GetVariable(1)

	{{APIComment\|'Change the variable's name to "New_Name."}}		{{APIComment\|'Change the variable's name to "New_Name."}}
	MyVariable.Name = {{APIString\|"New_Name"}}		MyVariable.Name = {{APIString\|"New_Name"}}

	{{APIComment\|'~~Apply~~ the change to ~~the variable. Changes are recorded in~~ the Synthesis repository.}}		{{APIComment\|'Send the change to the Synthesis repository.}}
	{{APIPrefix\|Call}} MyRepository.Variable.UpdateVariable(MyVariable)		{{APIPrefix\|Call}} MyRepository.Variable.UpdateVariable(MyVariable)

	'''VB.NET'''		'''VB.NET'''

	{{APIComment\|'~~Add code to~~ connect to a Synthesis repository.}}		{{APIComment\|'Declare a new Repository object and connect to a Synthesis repository.}}
	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	{{~~APIComment~~\|...}}		MyRepository.ConnectToAccessRepository({{APIString\|"C:\RSRepository1.rsr10"}})


	{{APIComment\|'Get variable #1 from project #1.}}		{{APIComment\|'Get variable #1 from project #1.}}
	{{APIPrefix\|Dim}} MyVariable {{APIPrefix\|As}} cVariable		{{APIPrefix\|Dim}} MyVariable {{APIPrefix\|As}} cVariable
	MyRepository.Project.SetCurrentProject(1)		MyRepository.Project.SetCurrentProject(1)
	MyVariable = MyRepository.Variable.GetVariable(1)		MyVariable = MyRepository.Variable.GetVariable(1)

	{{APIComment\|'Change the variable's name to "New_Name."}}		{{APIComment\|'Change the variable's name to "New_Name."}}
	MyVariable.Name = {{APIString\|"New_Name"}}		MyVariable.Name = {{APIString\|"New_Name"}}

	{{APIComment\|'~~Apply~~ the change to ~~the variable. Changes are recorded in~~ the Synthesis repository.}}		{{APIComment\|'Send the change to the Synthesis repository.}}
	MyRepository.Variable.UpdateVariable(MyVariable)		MyRepository.Variable.UpdateVariable(MyVariable)