Repository.Unit.GetAllUnits: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:




<onlyinclude>Gets a list of all the predefined units of measurement in the current repository. Returns a '''[[UnitInfo Class|UnitInfo]]''' object array that contains the unit names, ID numbers, abbreviations and multipliers.</onlyinclude>
<onlyinclude>Gets the units of measurement associated with a Synthesis repository. Returns a '''[[UnitInfo Class|UnitInfo]]''' object array that contains all the predefined units of measurements in that repository.</onlyinclude>


== Syntax ==
== Syntax ==
Line 16: Line 16:
   
   
    
    
  {{APIComment|'Get a list of all units in the repository.}}
  {{APIComment|'Get a list of all defined units in the repository.}}
   {{APIPrefix|Dim}} ListOfUnits() {{APIPrefix|As}} UnitInfo
   {{APIPrefix|Dim}} ListOfUnits() {{APIPrefix|As}} UnitInfo
   ListOfUnits = MyRepository.Unit.GetAllUnits()
   ListOfUnits = MyRepository.Unit.GetAllUnits()
   
   
  {{APIComment|'Output example: Display the name and ID of the first available unit in the repository.}}
  {{APIComment|'Output sample: Display the number of elements in the array.}}
   Dim UnitName {{APIPrefix|As}} String
   {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  Dim UnitID {{APIPrefix|As}} Integer
   NumberofElements = UBound(ListofUnits) - LBound(ListofUnits) + 1
   UnitName = ListofUnits(0).Name
   MsgBox (NumberofElements)
  UnitID = ListofUnits(0).ID
   MsgBox ({{APIString|"The first available unit is: "}} & UnitName & {{APIString|", ID#"}} & UnitID)

Revision as of 15:48, 25 August 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Gets the units of measurement associated with a Synthesis repository. Returns a UnitInfo object array that contains all the predefined units of measurements in that repository.

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 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=60568"