Repository.Pool.UpdatePool: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|Repository}}</noinclude>
{{Template:Repository.UpdatePool.Cmt}} {{Template:BooleanReturn.Cmt}}


== Syntax ==
Saves all updates to a spare part pool. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update. 
*UpdatePool( pool {{APIPrefix|As}} [[cPool Class|cPool]] ){{APIPrefix|As Boolean}}
<noinclude>
== Syntax ==
''object''.'''Pool.UpdatePool(''pool'')'''


Parameters
where ''object'' is a variable that represents a Repository object.
:''pool'': The [[cPool Class|cPool]] to update.


== Usage Example ==
=== Parameters ===
{{APIComment|'Declare a new repository connection object.}}
{| {{APITable}}
   Dim MyRepository As New Repository
|-
|pool{{APIParam|Required}}||The [[CPool Class|cPool]] object to be updated.
|}
 
 
== Example ==
This example assumes that a spare part pool with ID#1 exists in the repository.
 
'''VBA'''
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|...'Add code to connect to a Synthesis repository.}}
    
    
  {{APIComment|'Connect to the Synthesis repository.}}
  {{APIComment|'Get spare part pool #1 from project #1.}}
   Dim Success As Boolean = False
   {{APIPrefix|Dim}} MyPool {{APIPrefix|As}} cPool
   Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
  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|'Apply the update to the spare part pool. Changes will be reflected in the repository.}}
  {{APIPrefix|Call}} MyRepository.Pool.UpdatePool(MyPool)
 
'''VB.NET'''
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|...'Add code to connect to a Synthesis repository.}}
    
    
  {{APIComment|'Set a first available project as current.}}
  {{APIComment|'Get spare part pool #1 from project #1.}}
   MyRepository.Project.SetCurrentProject(0)
  {{APIPrefix|Dim}} MyPool {{APIPrefix|As}} cPool
   MyRepository.Project.SetCurrentProject(1) 
  MyPool = MyRepository.Pool.GetPool(1)
   
   
  {{APIComment|'Get the list of pools in the current project.}}
  {{APIComment|'Change the pool's name to "New_Name."}}
   Dim ListOfPools() As [[cPool Class|cPool]]
   MyPool.Name = {{APIString|"New_Name"}}
  ListOfPools = MyRepository.Pool.GetAllPools()
 
  {{APIComment|'Apply the update to the spare part pool. Changes will be reflected in the repository.}}
  {{APIComment|'After modifying the pool, update the repository.}}
   MyRepository.Pool.UpdatePool(MyPool)
   Dim SuccessUpdatePool As Boolean = False
</noinclude>
  SuccessUpdatePool = MyRepository.Pool.UpdatePool(ListOfPools(0))

Revision as of 22:08, 16 July 2015

APIWiki.png


Member of: SynthesisAPI10Repository

Saves all updates to a spare part pool. Changes are reflected in the repository immediately upon refresh. Returns a Boolean value; when true, indicates a successful update.

Syntax

object.Pool.UpdatePool(pool)

where object is a variable that represents a Repository object.

Parameters

Name Description
poolborder="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse; text-align: left; cellborder"
Name Status The cPool object to be updated.


Example

This example assumes that a spare part pool with ID#1 exists in the repository. 

VBA

 Dim MyRepository As New Repository
 ...'Add code to connect to a Synthesis 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

 Dim MyRepository As New Repository
 ...'Add code to connect to a Synthesis 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)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Pool.UpdatePool&oldid=59458"