Repository.Unit.GetAllUnits: Difference between revisions

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




<onlyinclude>Gets a list of all predefined units in the current repository. In Synthesis desktop applications, these units are shown in the Manage Units window. Returns a '''[[UnitInfo Class|UnitInfo]]''' object array that contains the unit names, ID numbers, abbreviations and multipliers.</onlyinclude>
<onlyinclude>Gets a list of all the predefined units of measurement in the current repository. Returns a '''[[UnitInfo Class|UnitInfo]]''' object array that contains the unit names, ID numbers, abbreviations and multipliers.</onlyinclude>


== Syntax ==
== Syntax ==

Revision as of 16:28, 21 August 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


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

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)