Repository.Pool.UpdatePool: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
 
(10 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
{{Template:Repository.UpdatePool.Cmt}} {{Template:BooleanReturn.Cmt}}


== Syntax  ==
*UpdatePool( pool {{APIPrefix|As}} [[cPool Class|cPool]] ){{APIPrefix|As Boolean}}


Parameters
<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> 
:''pool'': The [[cPool Class|cPool]] to update.


== Usage Example ==
== Syntax ==
  {{APIComment|'Declare a new repository connection object.}}
'''.Pool.UpdatePool'''(''pool'')
  Dim MyRepository As New Repository
 
 
=== Parameters ===
  {{APIComment|'Connect to the Synthesis repository.}}
''pool''
  Dim Success As Boolean = False
:Required. The [[CPool Class|cPool]] object that represents the spare part pool to be updated.
  Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
 
 
 
  {{APIComment|'Get the list of pools in the connected repository.}}
== Example ==
  Dim ListOfPools() As [[cPool Class|cPool]]
This example assumes that a spare part pool with ID #1 exists in the first available project of a repository.
  ListOfPools = MyRepository.GetAllPools()
 
 
'''VBA'''
  {{APIComment|'After modifying the pool, update the repository.}}
  Dim SuccessUpdatePool As Boolean = False
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  SuccessUpdatePool = MyRepository.UpdatePool(ListOfPools(0))
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
{{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."}}
  MyPool.Name = {{APIString|"New_Name"}}
{{APIComment|'Send the change to the Synthesis repository.}}
  {{APIPrefix|Call}} MyRepository.Pool.UpdatePool(MyPool)
 
'''VB.NET'''
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
  {{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."}}
  MyPool.Name = {{APIString|"New_Name"}}
{{APIComment|'Send the change to the Synthesis repository.}}
  MyRepository.Pool.UpdatePool(MyPool)

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)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Pool.UpdatePool&oldid=64263"