Repository.Pool.UpdatePool: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
| (4 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}} | |||
<onlyinclude>Updates the properties of a given spare part pool in the current project. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude> | |||
== Syntax == | == Syntax == | ||
'''.Pool.UpdatePool'''(''pool'') | '''.Pool.UpdatePool'''(''pool'') | ||
=== Parameters === | === Parameters === | ||
''pool'' | ''pool'' | ||
:The [[CPool Class|cPool]] object to be updated. | :Required. The [[CPool Class|cPool]] object that represents the spare part pool to be updated. | ||
== Example == | == Example == | ||
This example assumes that a spare part pool with ID#1 exists in the repository. | This example assumes that a spare part pool with ID #1 exists in the first available project of a repository. | ||
'''VBA''' | '''VBA''' | ||
{{APIComment|' | {{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 | ||
MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}}) | |||
{{APIComment|'Get spare part pool #1 from project #1.}} | {{APIComment|'Get spare part pool #1 from project #1.}} | ||
{{APIPrefix|Dim}} MyPool {{APIPrefix|As}} cPool | |||
MyRepository.Project.SetCurrentProject(1) | |||
{{APIPrefix|Set}} MyPool = MyRepository.Pool.GetPool(1) | |||
{{APIComment|'Change the pool's name to "New_Name."}} | {{APIComment|'Change the pool's name to "New_Name."}} | ||
MyPool.Name = {{APIString|"New_Name"}} | |||
{{APIComment|' | {{APIComment|'Send the change to the Synthesis repository.}} | ||
{{APIPrefix|Call}} MyRepository.Pool.UpdatePool(MyPool) | |||
'''VB.NET''' | '''VB.NET''' | ||
{{APIComment|' | {{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 | ||
MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}}) | |||
{{APIComment|'Get spare part pool #1 from project #1.}} | {{APIComment|'Get spare part pool #1 from project #1.}} | ||
{{APIPrefix|Dim}} MyPool {{APIPrefix|As}} cPool | |||
MyRepository.Project.SetCurrentProject(1) | |||
MyPool = MyRepository.Pool.GetPool(1) | |||
{{APIComment|'Change the pool's name to "New_Name."}} | {{APIComment|'Change the pool's name to "New_Name."}} | ||
MyPool.Name = {{APIString|"New_Name"}} | |||
{{APIComment|' | {{APIComment|'Send the change to the Synthesis repository.}} | ||
MyRepository.Pool.UpdatePool(MyPool) | |||
Latest revision as of 17:29, 9 June 2016
 |
Member of: SynthesisAPI.Repository
Updates the properties of a given spare part pool in the current project. Returns a Boolean value; when true, indicates a successful update.
Syntax
.Pool.UpdatePool(pool)
Parameters
pool
- Required. The cPool object that represents the spare part pool to be updated.
Example
This example assumes that a spare part pool with ID #1 exists in the first available project of a repository.
VBA 'Declare a new Repository object and connect to a Synthesis repository. Dim MyRepository As New Repository MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10") 'Get spare part pool #1 from project #1. Dim MyPool As cPool MyRepository.Project.SetCurrentProject(1) Set MyPool = MyRepository.Pool.GetPool(1) 'Change the pool's name to "New_Name." MyPool.Name = "New_Name" 'Send the change to the Synthesis repository. Call MyRepository.Pool.UpdatePool(MyPool)
VB.NET 'Declare a new Repository object and connect to a Synthesis repository. Dim MyRepository As New Repository MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10") 'Get spare part pool #1 from project #1. Dim MyPool As cPool MyRepository.Project.SetCurrentProject(1) MyPool = MyRepository.Pool.GetPool(1) 'Change the pool's name to "New_Name." MyPool.Name = "New_Name" 'Send the change to the Synthesis repository. MyRepository.Pool.UpdatePool(MyPool)