Repository.Pool.UpdatePool: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
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 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.</onlyinclude>   
 
<onlyinclude>Applies any changes made to an existing spare part pool. Returns a '''Boolean''' value; when true, indicates a successful save.</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 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'''
Line 28: Line 30:
   MyPool.Name = {{APIString|"New_Name"}}
   MyPool.Name = {{APIString|"New_Name"}}
   
   
  {{APIComment|'Apply the update to the spare part pool. Changes will be reflected in the repository.}}
  {{APIComment|'Apply the change to the spare part pool. Changes are recorded in the Synthesis repository.}}
   {{APIPrefix|Call}} MyRepository.Pool.UpdatePool(MyPool)
   {{APIPrefix|Call}} MyRepository.Pool.UpdatePool(MyPool)


Line 46: Line 48:
   MyPool.Name = {{APIString|"New_Name"}}
   MyPool.Name = {{APIString|"New_Name"}}
   
   
  {{APIComment|'Apply the update to the spare part pool. Changes will be reflected in the repository.}}
  {{APIComment|'Apply the change to the spare part pool. Changes are recorded in the Synthesis repository.}}
   MyRepository.Pool.UpdatePool(MyPool)
   MyRepository.Pool.UpdatePool(MyPool)

Revision as of 21:04, 24 August 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Applies any changes made to an existing spare part pool. Returns a Boolean value; when true, indicates a successful save.

Syntax

.Pool.UpdatePool(pool)

Parameters

pool

Required. The cPool object 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

 '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 change to the spare part pool. Changes are recorded in the Synthesis 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 change to the spare part pool. Changes are recorded in the Synthesis repository. 
 MyRepository.Pool.UpdatePool(MyPool)