Repository.Unit.GetAllUnits: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}} | |||
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. | <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> | ||
== Syntax == | == Syntax == | ||
'''.Unit.GetAllUnits()''' | '''.Unit.GetAllUnits()''' | ||
| Line 28: | Line 26: | ||
UnitID = ListofUnits(0).ID | UnitID = ListofUnits(0).ID | ||
MsgBox ({{APIString|"The first available unit is: "}} & UnitName & {{APIString|", ID#"}} & UnitID) | MsgBox ({{APIString|"The first available unit is: "}} & UnitName & {{APIString|", ID#"}} & UnitID) | ||
Revision as of 22:09, 20 July 2015
 |
Member of: SynthesisAPI10.Repository
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 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)