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 |
||
| Line 1: | Line 1: | ||
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|[[Repository Class|Repository]]}}</noinclude> | <noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}</noinclude> | ||
Updates the properties of an existing spare part pool 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 == | ||
' | '''.Pool.UpdatePool'''(''pool'') | ||
=== Parameters === | === Parameters === | ||
''pool'' | |||
:The [[CPool Class|cPool]] object to be updated. | |||
| Line 20: | Line 15: | ||
'''VBA''' | '''VBA''' | ||
{{APIComment|'Add code to connect to a Synthesis repository.}} | |||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | |||
{{APIComment|...}} | |||
{{APIComment|'Get spare part pool #1 from project #1.}} | {{APIComment|'Get spare part pool #1 from project #1.}} | ||
| Line 36: | Line 33: | ||
'''VB.NET''' | '''VB.NET''' | ||
{{APIComment|'Add code to connect to a Synthesis repository.}} | |||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | |||
{{APIComment|...}} | |||
{{APIComment|'Get spare part pool #1 from project #1.}} | {{APIComment|'Get spare part pool #1 from project #1.}} | ||
Revision as of 20:31, 20 July 2015
 |
Member of: SynthesisAPI10.Repository
Updates the properties of an existing spare part pool in the current project. Changes are reflected in the repository immediately upon refresh. Returns a Boolean value; when true, indicates a successful update.
Syntax
.Pool.UpdatePool(pool)
Parameters
pool
- The cPool object to be updated.
Example
This example assumes that a spare part pool with ID#1 exists in the repository.
VBA 'Add code to connect to a Synthesis repository. Dim MyRepository As New Repository ... '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" 'Apply the update to the spare part pool. Changes will be reflected in the repository. Call MyRepository.Pool.UpdatePool(MyPool)
VB.NET 'Add code to connect to a Synthesis repository. Dim MyRepository As New Repository ... '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" 'Apply the update to the spare part pool. Changes will be reflected in the repository. MyRepository.Pool.UpdatePool(MyPool)