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:APIBreadcrumb|10|Repository}} | {{Template:APIBreadcrumb|10|Repository}} | ||
{{Template:API}} | {{Template:API}} | ||
Returns a '''[[UnitInfo Class|UnitInfo]]''' object array that contains the | 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. | ||
In Synthesis desktop applications, these units are shown in the Manage Units window. | |||
== Syntax == | == Syntax == | ||
''object''.''' | ''object''.'''Unit.GetAllUnits()''' | ||
where ''object'' is a variable that represents a Repository object. | where ''object'' is a variable that represents a Repository object. | ||
| Line 11: | Line 13: | ||
'''VBA|VB.NET'''<br> | '''VBA|VB.NET'''<br> | ||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | ||
{{APIComment|...'Add code to connect to a Synthesis repository | {{APIComment|...'Add code to connect to a Synthesis repository.}} <br> | ||
{{APIPrefix|Dim}} ListOfUnits() {{APIPrefix|As}} UnitInfo | {{APIPrefix|Dim}} ListOfUnits() {{APIPrefix|As}} UnitInfo | ||
ListOfUnits = MyRepository.Unit.GetAllUnits()<br> | ListOfUnits = MyRepository.Unit.GetAllUnits()<br> | ||
Revision as of 22:20, 13 July 2015
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: 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)