Repository.Task.UpdateScheduledTask - Revision history

Kate Racaza at 17:38, 9 June 2016

2016-06-09T17:38:11Z

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


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

	== Syntax ==		== Syntax ==
Line 9:		Line 9:
	=== Parameters ===		=== Parameters ===
	''task''		''task''
	:Required. The [[CScheduledTask Class\|cScheduledTask]] object to be updated.		:Required. The [[CScheduledTask Class\|cScheduledTask]] object that represents the scheduled task to be updated.

Kate Racaza at 18:43, 8 April 2016

2016-04-08T18:43:05Z

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


	<onlyinclude>~~Applies~~ any changes made to an existing scheduled task. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>		<onlyinclude>Sends any changes made to an existing scheduled task 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 scheduled task #1 from project #1.}}		{{APIComment\|'Get scheduled task #1 from project #1.}}
	{{APIPrefix\|Dim}} MyTask {{APIPrefix\|As}} cScheduledTask		{{APIPrefix\|Dim}} MyTask {{APIPrefix\|As}} cScheduledTask
	MyRepository.Project.SetCurrentProject(1)		MyRepository.Project.SetCurrentProject(1)
	{{APIPrefix\|Set}} MyTask = MyRepository.Task.GetScheduledTask(1)		{{APIPrefix\|Set}} MyTask = MyRepository.Task.GetScheduledTask(1)

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

	{{APIComment\|'~~Apply~~ the change to ~~the task. Changes are recorded in~~ the Synthesis repository.}}		{{APIComment\|'Send the change to the Synthesis repository.}}
	{{APIPrefix\|Call}} MyRepository.Task.UpdateScheduledTask(MyTask)		{{APIPrefix\|Call}} MyRepository.Task.UpdateScheduledTask(MyTask)

	'''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 scheduled task #1 from project #1.}}		{{APIComment\|'Get scheduled task #1 from project #1.}}
	{{APIPrefix\|Dim}} MyTask {{APIPrefix\|As}} cScheduledTask		{{APIPrefix\|Dim}} MyTask {{APIPrefix\|As}} cScheduledTask
	MyRepository.Project.SetCurrentProject(1)		MyRepository.Project.SetCurrentProject(1)
	MyTask = MyRepository.Task.GetScheduledTask(1)		MyTask = MyRepository.Task.GetScheduledTask(1)

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

	{{APIComment\|'~~Apply~~ the change to ~~the task. Changes are recorded in~~ the Synthesis repository.}}		{{APIComment\|'Send the change to the Synthesis repository.}}
	MyRepository.Task.UpdateScheduledTask(MyTask)		MyRepository.Task.UpdateScheduledTask(MyTask)

Kate Racaza at 22:18, 13 November 2015

2015-11-13T22:18:59Z

← Older revision		Revision as of 22:18, 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 21:00, 24 August 2015

2015-08-24T21:00:06Z

← Older revision		Revision as of 21:00, 24 August 2015
Line 2:		Line 2:


	<onlyinclude>~~Updates the properties of~~ an existing scheduled task ~~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 scheduled task. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>

	== Syntax ==		== Syntax ==
	'''.Task.UpdateScheduledTask'''(''task'')		'''.Task.UpdateScheduledTask'''(''task'')

	=== Parameters ===		=== Parameters ===
	''task''		''task''
	:The [[CScheduledTask Class\|cScheduledTask]] object to be updated.		:Required. The [[CScheduledTask Class\|cScheduledTask]] object to be updated.


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

	'''VBA'''		'''VBA'''
Line 29:		Line 30:
	MyTask.Name = {{APIString\|"New_Name"}}		MyTask.Name = {{APIString\|"New_Name"}}

	{{APIComment\|'Apply the ~~update~~ to the ~~URD~~. Changes ~~will be reflected~~ in the repository.}}		{{APIComment\|'Apply the change to the task. Changes are recorded in the Synthesis repository.}}
	{{APIPrefix\|Call}} MyRepository.Task.UpdateScheduledTask(MyTask)		{{APIPrefix\|Call}} MyRepository.Task.UpdateScheduledTask(MyTask)

Line 47:		Line 48:
	MyTask.Name = {{APIString\|"New_Name"}}		MyTask.Name = {{APIString\|"New_Name"}}

	{{APIComment\|'Apply the ~~update~~ to the ~~URD~~. Changes ~~will be reflected~~ in the repository.}}		{{APIComment\|'Apply the change to the task. Changes are recorded in the Synthesis repository.}}
	MyRepository.Task.UpdateScheduledTask(MyTask)		MyRepository.Task.UpdateScheduledTask(MyTask)

Kate Racaza at 20:24, 21 July 2015

2015-07-21T20:24:30Z

← Older revision		Revision as of 20:24, 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 scheduled task 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 scheduled task 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 ==
	'''.Task.UpdateScheduledTask'''(''task'')		'''.Task.UpdateScheduledTask'''(''task'')
Line 48:		Line 49:
	{{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.Task.UpdateScheduledTask(MyTask)		MyRepository.Task.UpdateScheduledTask(MyTask)
	~~</noinclude>~~

Kate Racaza at 20:29, 20 July 2015

2015-07-20T20:29:53Z

← Older revision		Revision as of 20:29, 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~~ scheduled task. 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 scheduled task 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~~''.'''~~Task.UpdateScheduledTask~~(''task'')~~'''~~		'''.Task.UpdateScheduledTask'''(''task'')

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

	=== Parameters ===		=== Parameters ===
	~~{\| {{APITable}}~~		''task''
	\|-		:The [[CScheduledTask Class\|cScheduledTask]] object to be updated.
	~~\|task{{APIParam\|Required}}\|\|~~The [[CScheduledTask Class\|cScheduledTask]] 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 scheduled task #1 from project #1.}}		{{APIComment\|'Get scheduled task #1 from project #1.}}
	{{APIPrefix\|Dim}} MyTask {{APIPrefix\|As}} cScheduledTask		{{APIPrefix\|Dim}} MyTask {{APIPrefix\|As}} cScheduledTask
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 scheduled task #1 from project #1.}}		{{APIComment\|'Get scheduled task #1 from project #1.}}

Kate Racaza at 17:29, 17 July 2015

2015-07-17T17:29:46Z

← Older revision		Revision as of 17:29, 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 scheduled task. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.		Saves all updates to a scheduled task. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.

Kate Racaza at 22:00, 16 July 2015

2015-07-16T22:00:26Z

← Older revision		Revision as of 22:00, 16 July 2015
Line 1:		Line 1:
	{{Template:~~APIClass\|Repository Class\|Repository~~}}		<noinclude>{{Template:API}}{{Template:APIBreadcrumb\|10\|Repository}}</noinclude>
	~~Updates the specified task in the repository.~~ {{Template:~~BooleanReturn.Cmt~~}}

	== Syntax ==		Saves all updates to a scheduled task. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.
	*UpdateScheduledTask( task ~~{{APIPrefix\|As}} [[cScheduledTask Class\|cScheduledTask]]~~ )~~{{APIPrefix\|As Boolean}}~~		<noinclude>
			== Syntax ==
			''object''.'''Task.UpdateScheduledTask(''task'')'''

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

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


			== Example ==
			This example assumes that a scheduled task 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 scheduled task #1 from project #1.}}
	Dim ~~Success~~ As ~~Boolean = False~~		{{APIPrefix\|Dim}} MyTask {{APIPrefix\|As}} cScheduledTask
	~~Success~~ = MyRepository.~~ConnectToRepository~~("~~RepositoryFileNamePath~~")		MyRepository.Project.SetCurrentProject(1)
			{{APIPrefix\|Set}} MyTask = MyRepository.Task.GetScheduledTask(1)

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

			{{APIComment\|'Apply the update to the URD. Changes will be reflected in the repository.}}
			{{APIPrefix\|Call}} MyRepository.Task.UpdateScheduledTask(MyTask)

			'''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 scheduled task #1 from project #1.}}
	MyRepository.Project.SetCurrentProject(0)		{{APIPrefix\|Dim}} MyTask {{APIPrefix\|As}} cScheduledTask
			MyRepository.Project.SetCurrentProject(1)
			MyTask = MyRepository.Task.GetScheduledTask(1)

	{{APIComment\|'~~Get~~ the ~~list of scheduled tasks from the current project~~.}}		{{APIComment\|'Change the task's name to "New_Name."}}
	~~Dim ListOfTasks() As [[cScheduledTask Class~~\|~~cScheduledTask]]~~		MyTask.Name = {{APIString\|"New_Name"}}
	~~ListOfTasks = MyRepository.Task.GetAllScheduledTasks()~~
			{{APIComment\|'Apply the update to the URD. Changes will be reflected in the repository.}}
	{{APIComment\|'~~After updating~~ the ~~task,~~ update the repository}}		MyRepository.Task.UpdateScheduledTask(MyTask)
	~~Dim Success As Boolean~~		</noinclude>
	~~Success =~~ MyRepository.Task.UpdateScheduledTask(~~ListOfTasks(0)~~)

Alex Ulanov: /* Syntax */

2015-05-22T21:02:07Z

Syntax

← Older revision		Revision as of 21:02, 22 May 2015
Line 3:		Line 3:

	== Syntax ==		== Syntax ==
	*UpdateScheduledTask( task {{APIPrefix\|As}} [[cScheduledTask Class\|cScheduledTask]] ){{APIPrefix\|As Boolean~~}} {{APIComment\|{{Template:Repository.UpdateScheduledTask.Cmt}}~~}}		*UpdateScheduledTask( task {{APIPrefix\|As}} [[cScheduledTask Class\|cScheduledTask]] ){{APIPrefix\|As Boolean}}

	Parameters		Parameters

Alex Ulanov: Created page with '{{Template:APIClass|Repository Class|Repository}} Updates the specified task in the repository. {{Template:BooleanReturn.Cmt}} == Syntax == *UpdateScheduledTask( task {{APIPref…'

2015-05-22T21:01:30Z

Created page with '{{Template:APIClass|Repository Class|Repository}} Updates the specified task in the repository. {{Template:BooleanReturn.Cmt}} == Syntax == *UpdateScheduledTask( task {{APIPref…'

New page

{{Template:APIClass|Repository Class|Repository}}
Updates the specified task in the repository. {{Template:BooleanReturn.Cmt}}

== Syntax ==
*UpdateScheduledTask( task {{APIPrefix|As}} [[cScheduledTask Class|cScheduledTask]] ){{APIPrefix|As Boolean}} {{APIComment|{{Template:Repository.UpdateScheduledTask.Cmt}}}}

Parameters
:''task'': The [[cScheduledTask Class|cScheduledTask]] to update.

== Usage Example ==
{{APIComment|'Declare a new repository connection object.}}
Dim MyRepository As New Repository

{{APIComment|'Connect to the Synthesis repository.}}
Dim Success As Boolean = False
Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")

{{APIComment|'Set a first available project as current.}}
MyRepository.Project.SetCurrentProject(0)

{{APIComment|'Get the list of scheduled tasks from the current project.}}
Dim ListOfTasks() As [[cScheduledTask Class|cScheduledTask]]
ListOfTasks = MyRepository.Task.GetAllScheduledTasks()

{{APIComment|'After updating the task, update the repository}}
Dim Success As Boolean
Success = MyRepository.Task.UpdateScheduledTask(ListOfTasks(0))

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


	<onlyinclude>~~Applies~~ any changes made to an existing scheduled task. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>		<onlyinclude>Sends any changes made to an existing scheduled task 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 scheduled task #1 from project #1.}}		{{APIComment\|'Get scheduled task #1 from project #1.}}
	{{APIPrefix\|Dim}} MyTask {{APIPrefix\|As}} cScheduledTask		{{APIPrefix\|Dim}} MyTask {{APIPrefix\|As}} cScheduledTask
	MyRepository.Project.SetCurrentProject(1)		MyRepository.Project.SetCurrentProject(1)
	{{APIPrefix\|Set}} MyTask = MyRepository.Task.GetScheduledTask(1)		{{APIPrefix\|Set}} MyTask = MyRepository.Task.GetScheduledTask(1)

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

	{{APIComment\|'~~Apply~~ the change to ~~the task. Changes are recorded in~~ the Synthesis repository.}}		{{APIComment\|'Send the change to the Synthesis repository.}}
	{{APIPrefix\|Call}} MyRepository.Task.UpdateScheduledTask(MyTask)		{{APIPrefix\|Call}} MyRepository.Task.UpdateScheduledTask(MyTask)

	'''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 scheduled task #1 from project #1.}}		{{APIComment\|'Get scheduled task #1 from project #1.}}
	{{APIPrefix\|Dim}} MyTask {{APIPrefix\|As}} cScheduledTask		{{APIPrefix\|Dim}} MyTask {{APIPrefix\|As}} cScheduledTask
	MyRepository.Project.SetCurrentProject(1)		MyRepository.Project.SetCurrentProject(1)
	MyTask = MyRepository.Task.GetScheduledTask(1)		MyTask = MyRepository.Task.GetScheduledTask(1)

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

	{{APIComment\|'~~Apply~~ the change to ~~the task. Changes are recorded in~~ the Synthesis repository.}}		{{APIComment\|'Send the change to the Synthesis repository.}}
	MyRepository.Task.UpdateScheduledTask(MyTask)		MyRepository.Task.UpdateScheduledTask(MyTask)