Repository.Unit.GetAllUnits

From ReliaWiki
Revision as of 20:23, 13 July 2015 by Kate Racaza (talk | contribs)
Jump to navigation Jump to search

Member of: SynthesisAPI10Repository

APIWiki.png


Returns a UnitInfo object array that contains the name, ID number, abbreviation and multiplier of all predefined units in the current repository. In Synthesis desktop applications, these units are shown in the Manage Units window.

Syntax

object.Project.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 and set the first project in the repository as the current project.
Dim ListOfUnits() As UnitInfo ListOfUnits = MyRepository.Unit.GetAllUnits()
'Output example: Get the name and ID of the first available unit in the repository and display them in a message box. 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)