Repository.Unit.GetAllUnits: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|Repository}}</noinclude>
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|[[Repository Class|Repository]]}}</noinclude>


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

Revision as of 17:25, 17 July 2015

APIWiki.png


Member of: SynthesisAPI10Repository

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

object.Unit.GetAllUnits()

where object is a variable that represents a Repository object.

Example

VBA|VB.NET

 Dim MyRepository As New Repository
 ...'Add code to connect to a Synthesis 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)