Difference between revisions of "Repository.Pool.AddPool"

From ReliaWiki
Jump to navigation Jump to search
Line 2: Line 2:
  
  
<onlyinclude>Adds a new spare part pool to a project. Returns a '''Boolean''' value; when true, indicates indicates a successful save.</onlyinclude>  
+
<onlyinclude>Adds a new spare part pool to the current project. Returns a '''Boolean''' value; when true, indicates indicates a successful save.</onlyinclude>  
  
 
If a pool with the same name already exists in the destination project, the name will be incremented automatically. For example, if "Pool1" already exists, the new pool might be renamed to "Pool2," "Pool3," etc.  
 
If a pool with the same name already exists in the destination project, the name will be incremented automatically. For example, if "Pool1" already exists, the new pool might be renamed to "Pool2," "Pool3," etc.  
Line 11: Line 11:
 
=== Parameters ===
 
=== Parameters ===
 
''pool''
 
''pool''
:Required. The [[CPool Class|cPool]] object to be added.
+
:Required. The [[CPool Class|cPool]] object that represents the spare part pool to be added.
  
  

Revision as of 17:19, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Adds a new spare part pool to the current project. Returns a Boolean value; when true, indicates indicates a successful save.

If a pool with the same name already exists in the destination project, the name will be incremented automatically. For example, if "Pool1" already exists, the new pool might be renamed to "Pool2," "Pool3," etc.

Syntax

.Pool.AddPool(pool)

Parameters

pool

Required. The cPool object that represents the spare part pool to be added.


Example

This example creates a new spare part pool resource, and then saves it in the first available project in a Synthesis repository.

VBA

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
 
 'Create a new pool. The following example creates a pool named "MyNewSpares." 
  Dim NewSpares As New cPool
  NewSpares.Name = "MyNewSpares"

 'Add the new spare part pool to project #1. 
  MyRepository.Project.SetCurrentProject(1)   
  Call MyRepository.Pool.AddPool(NewSpares)
VB.NET

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")

 'Create a new pool. The following example creates a pool named "MyNewSpares." 
  Dim NewSpares As New cPool ("MyNewSpares")

 'Add the new spare part pool to project #1. 
  MyRepository.Project.SetCurrentProject(1)   
  MyRepository.Pool.AddPool(NewSpares)