Repository.Pool.UpdatePool: Difference between revisions

Latest revision as of 17:29, 9 June 2016

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)

@@ Line 1: / Line 1: @@
-{{Template:APIClass|Repository Class|Repository}}
+{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
-Updates the spare parts Pool
-== Method Syntax  ==
-{{APIName|'''UpdatePool'''(}}
-{{APIPrefix|ByVal}}
-{{APIName|pool}}
-{{APIPrefix|As}}
-{{APIName|[[cPool Class|cPool]])}}
-{{APIPrefix|As Boolean}}<br>
-{{APIComment|Updates the spare parts Pool in the repository.}}
-== Parameters ==
-'''pool'''
-{{APIComment|The pool to update in the repository.}}
-== Usage Example ==
+<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>
-{{APIComment|Declare a new repository connection class.}}
-        Private WithEvents MyRepository As New Repository
-{{APIComment|Connect to the Synthesis repository.}}
+== Syntax ==
-        Dim Success As Boolean = False
+ '''.Pool.UpdatePool'''(''pool'')
-        Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
-{{APIComment|Get the list of Pools in the connected repository.}}
+=== Parameters ===
-        Dim ListOfPools() As [[cPool Class|cPool]]
+''pool''
-        ListOfPools = MyRepository.GetAllPools()
+:Required. The [[CPool Class|cPool]] object that represents the spare part pool to be updated.
-{{APIComment|After modifying the Pool, update the repository.}}
-        Dim SuccessUpdatePool As Boolean = False
+== Example ==
-        SuccessUpdatePool = MyRepository.UpdatePool(ListOfPools(0))
+This example assumes that a spare part pool with ID #1 exists in the first available project of a repository.
+ '''VBA'''
+ {{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)
+   {{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)

Repository.Pool.UpdatePool: Difference between revisions

Latest revision as of 17:29, 9 June 2016

Syntax

Parameters

Example

Navigation menu

Search