Repository.Pool.UpdatePool: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
← Older edit
Kate Racaza (talk | contribs)
6,536 edits
No edit summary
Kate Racaza (talk | contribs)
6,536 edits
No edit summary
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|Repository}}</noinclude>
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
 
 
<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>


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. 
<noinclude>
== Syntax ==
== Syntax ==
''object''.'''Pool.UpdatePool(''pool'')'''
'''.Pool.UpdatePool'''(''pool'')
 
where ''object'' is a variable that represents a Repository object.


=== Parameters ===
=== Parameters ===
{| {{APITable}}
''pool''
|-
:Required. The [[CPool Class|cPool]] object that represents the spare part pool to be updated.
|pool{{APIParam|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'''
   
   
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
{{APIComment|...'Add code to 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.}}
  {{APIComment|'Get spare part pool #1 from project #1.}}
  {{APIPrefix|Dim}} MyPool {{APIPrefix|As}} cPool
  {{APIPrefix|Dim}} MyPool {{APIPrefix|As}} cPool
  MyRepository.Project.SetCurrentProject(1)   
  MyRepository.Project.SetCurrentProject(1)   
  {{APIPrefix|Set}} MyPool = MyRepository.Pool.GetPool(1)
  {{APIPrefix|Set}} MyPool = MyRepository.Pool.GetPool(1)
   
   
  {{APIComment|'Change the pool's name to "New_Name."}}
  {{APIComment|'Change the pool's name to "New_Name."}}
  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|'Send the change to the Synthesis repository.}}
  {{APIPrefix|Call}} MyRepository.Pool.UpdatePool(MyPool)
  {{APIPrefix|Call}} MyRepository.Pool.UpdatePool(MyPool)


  '''VB.NET'''
  '''VB.NET'''
   
   
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
{{APIComment|...'Add code to 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.}}
  {{APIComment|'Get spare part pool #1 from project #1.}}
  {{APIPrefix|Dim}} MyPool {{APIPrefix|As}} cPool
  {{APIPrefix|Dim}} MyPool {{APIPrefix|As}} cPool
  MyRepository.Project.SetCurrentProject(1)   
  MyRepository.Project.SetCurrentProject(1)   
  MyPool = MyRepository.Pool.GetPool(1)
  MyPool = MyRepository.Pool.GetPool(1)
   
   
  {{APIComment|'Change the pool's name to "New_Name."}}
  {{APIComment|'Change the pool's name to "New_Name."}}
  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|'Send the change to the Synthesis repository.}}
  MyRepository.Pool.UpdatePool(MyPool)
  MyRepository.Pool.UpdatePool(MyPool)
</noinclude>

Latest revision as of 17:29, 9 June 2016


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"