Repository.Pool.UpdatePool: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
m (Protected "Repository.UpdatePool" ([edit=sysop] (indefinite) [move=sysop] (indefinite)) [cascading])
No edit summary
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:APIClass|Repository Class|Repository}}
Updates the spare parts Pool
{{Template:Repository.UpdatePool.Cmt}} {{Template:BooleanReturn.Cmt}}
== 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 ==
== Syntax  ==
'''pool'''
*UpdatePool( pool {{APIPrefix|As}} [[cPool Class|cPool]] ){{APIPrefix|As Boolean}}
{{APIComment|The pool to update in the repository.}}
 
Parameters
:''pool'': The [[cPool Class|cPool]] to update.


== Usage Example ==
== Usage Example ==

Revision as of 18:45, 27 February 2014


Updates the spare parts pool in the repository. Returns True if successful, otherwise returns False.

Syntax

  • UpdatePool( pool As cPool )As Boolean

Parameters

pool: The cPool to update.

Usage Example

Declare a new repository connection class.

       Private WithEvents MyRepository As New Repository

Connect to the Synthesis repository.

       Dim Success As Boolean = False
       Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")

Get the list of Pools in the connected repository.

       Dim ListOfPools() As cPool
       ListOfPools = MyRepository.GetAllPools()

After modifying the Pool, update the repository.

       Dim SuccessUpdatePool As Boolean = False
       SuccessUpdatePool = MyRepository.UpdatePool(ListOfPools(0))