Repository.Unit.GetAllUnits: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(15 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Template:APIBreadcrumb|10|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
{{Template:API}}
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.  
 
<onlyinclude>Returns an array of '''[[UnitInfo Class|UnitInfo]]''' objects that represent the units of measurement associated with the Repository object.</onlyinclude>


== Syntax ==
== Syntax ==
''object''.'''Unit.GetAllUnits()'''
'''.Unit.GetAllUnits()'''


where ''object'' is a variable that represents a Repository object.


== Example ==
== Example ==
  '''VBA|VB.NET'''<br>
  '''VBA|VB.NET'''
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...'Add code to connect to a Synthesis repository.}} <br>
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} ListOfUnits() {{APIPrefix|As}} UnitInfo
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  ListOfUnits = MyRepository.Unit.GetAllUnits()<br>
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
  {{APIComment|'Output example: Get the name and ID of the first available unit in the repository and display them in a message box.}}
 
  Dim UnitName {{APIPrefix|As}} String
  {{APIComment|'Get a list of all defined units in the repository.}}
  Dim UnitID {{APIPrefix|As}} Integer<br>
  {{APIPrefix|Dim}} ListOfUnits() {{APIPrefix|As}} UnitInfo
  UnitName = ListofUnits(0).Name
  ListOfUnits = MyRepository.Unit.GetAllUnits()
  UnitID = ListofUnits(0).ID
  MsgBox ({{APIString|"The first available unit is: "}} & UnitName & {{APIString|", ID#"}} & UnitID)
  {{APIComment|'Output sample: Display the number of elements in the array.}}
  {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  NumberofElements = UBound(ListofUnits) - LBound(ListofUnits) + 1
  MsgBox (NumberofElements)

Latest revision as of 18:55, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Returns an array of UnitInfo objects that represent the units of measurement associated with the Repository object.

Syntax

.Unit.GetAllUnits()


Example

VBA|VB.NET

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
  
 'Get a list of all defined units in the repository. 
  Dim ListOfUnits() As UnitInfo
  ListOfUnits = MyRepository.Unit.GetAllUnits()

 'Output sample: Display the number of elements in the array. 
  Dim NumberofElements As Integer
  NumberofElements = UBound(ListofUnits) - LBound(ListofUnits) + 1
  MsgBox (NumberofElements)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Unit.GetAllUnits&oldid=64327"