Repository.Unit.GetAllUnits

From ReliaWiki
Revision as of 17:50, 20 July 2015 by Kate Racaza (talk | contribs)
Jump to navigation Jump to search
APIWiki.png


Member of: SynthesisAPI10.Repository


Gets a list of all predefined units in the current repository. Returns a UnitInfo object array that contains the unit names, ID numbers, abbreviations and multipliers.

In Synthesis desktop applications, these units are shown in the Manage Units window.

Syntax

.Unit.GetAllUnits()


Example

VBA|VB.NET

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

 
 'Get a list of all units in the repository. 
 Dim ListOfUnits() As UnitInfo
 ListOfUnits = MyRepository.Unit.GetAllUnits()

 'Output example: Display the name and ID of the first available unit in the repository. 
 Dim UnitName As String
 Dim UnitID As Integer
 UnitName = ListofUnits(0).Name
 UnitID = ListofUnits(0).ID
 MsgBox ("The first available unit is: " & UnitName & ", ID#" & UnitID)