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: | ||
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|[[Repository Class|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. | ||
| Line 6: | Line 7: | ||
<noinclude> | <noinclude> | ||
== Syntax == | == Syntax == | ||
' | '''.Unit.GetAllUnits()''' | ||
== Example == | == Example == | ||
'''VBA|VB.NET''' | '''VBA|VB.NET''' | ||
{{APIComment|'Add code to connect to a Synthesis repository.}} | |||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | |||
{{APIComment|...}} | |||
{{APIComment|'Get a list of all units in the repository.}} | |||
{{APIPrefix|Dim}} ListOfUnits() {{APIPrefix|As}} UnitInfo | {{APIPrefix|Dim}} ListOfUnits() {{APIPrefix|As}} UnitInfo | ||
ListOfUnits = MyRepository.Unit.GetAllUnits() | ListOfUnits = MyRepository.Unit.GetAllUnits() | ||
| Line 21: | Line 24: | ||
{{APIComment|'Output example: Display the name and ID of the first available unit in the repository.}} | {{APIComment|'Output example: Display the name and ID of the first available unit in the repository.}} | ||
Dim UnitName {{APIPrefix|As}} String | Dim UnitName {{APIPrefix|As}} String | ||
Dim UnitID {{APIPrefix|As}} Integer | Dim UnitID {{APIPrefix|As}} Integer | ||
UnitName = ListofUnits(0).Name | UnitName = ListofUnits(0).Name | ||
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) | ||
</noinclude> | </noinclude> | ||
Revision as of 17:50, 20 July 2015
 |
Member of: SynthesisAPI10.Repository
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
.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)