Repository.Pool.UpdatePool: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
Line 2: Line 2:




<onlyinclude>Sends any changes made to an existing spare part pool to the Synthesis repository. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>   
<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 ==
Line 9: Line 9:
=== Parameters ===
=== Parameters ===
''pool''
''pool''
:Required. The [[CPool Class|cPool]] object to be updated.
:Required. The [[CPool Class|cPool]] object that represents the spare part pool to be updated.





Latest revision as of 17:29, 9 June 2016

APIWiki.png


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)