Repository.Pool.AddPool: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:




<onlyinclude>Saves a new [[CPool Class|cPool]] object to the current project. Returns a '''Boolean''' value; when true, indicates indicates a successful save.</onlyinclude>  
<onlyinclude>Adds a new spare part pool to a Synthesis repository. 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 current project, the application will automatically increment the name. For example, if "Pool1" already exists, the new pool might be renamed to "Pool2," "Pool3," etc.
== Syntax ==
== Syntax ==
  '''.Pool.AddPool'''(''pool'')
  '''.Pool.AddPool'''(''pool'')
=== Parameters ===
=== Parameters ===
''pool''
''pool''
:The [[CPool Class|cPool]] object to be added. (Required)
:Required. The [[CPool Class|cPool]] object to be added.




Line 25: Line 27:
   NewSpares.Name = {{APIString|"MyNewSpares"}}
   NewSpares.Name = {{APIString|"MyNewSpares"}}
   
   
  {{APIComment|'Add the new spare part pool to project #1. The spare part pool will be visible in the Synthesis repository upon refresh.}}
  {{APIComment|'Add the new spare part pool to project #1.}}
   MyRepository.Project.SetCurrentProject(1)   
   MyRepository.Project.SetCurrentProject(1)   
   {{APIPrefix|Call}} MyRepository.Pool.AddPool(NewSpares)
   {{APIPrefix|Call}} MyRepository.Pool.AddPool(NewSpares)
Line 39: Line 41:
   {{APIPrefix|Dim}} NewSpares {{APIPrefix|As New}} cPool ({{APIString|"MyNewSpares"}})
   {{APIPrefix|Dim}} NewSpares {{APIPrefix|As New}} cPool ({{APIString|"MyNewSpares"}})
   
   
  {{APIComment|'Add the new spare part pool to project #1. The spare part pool will be visible in the Synthesis repository upon refresh.}}
  {{APIComment|'Add the new spare part pool to project #1.}}
   MyRepository.Project.SetCurrentProject(1)   
   MyRepository.Project.SetCurrentProject(1)   
   MyRepository.Pool.AddPool(NewSpares)
   MyRepository.Pool.AddPool(NewSpares)

Revision as of 21:48, 24 August 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Adds a new spare part pool to a Synthesis repository. 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 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

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ... 


 '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

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ... 


 '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)