Repository.Unit.GetAllUnits: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
m (Protected "Repository.GetAllUnits" ([edit=sysop] (indefinite) [move=sysop] (indefinite)) [cascading])
No edit summary
 
(25 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
Gets a list of the units in the current Synthesis project.


== Method Syntax==
{{APIName|'''GetAllUnits'''()}}
{{APIPrefix|As}}
{{APIName|[[UnitInfo Class|UnitInfo]]()}}<br>
{{APIComment|Returns the array containing all units from the current repository.}}


== Usage Example ==
<onlyinclude>Returns an array of '''[[UnitInfo Class|UnitInfo]]''' objects that represent the units of measurement associated with the Repository object.</onlyinclude>
{{APIComment|Declare a new repository connection class.}}
        Private WithEvents MyRepository As New Repository


{{APIComment|Connect to the Synthesis repository.}}
== Syntax ==
        Dim Success As Boolean = False
'''.Unit.GetAllUnits()'''
        Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")


{{APIComment|Get the list of Units for the Current Project for the connected repository.}}
 
        Dim ListOfUnits() As [[UnitInfo Class|UnitInfo]]
== Example ==
        ListOfUnits = MyRepository.GetAllUnits()
'''VBA|VB.NET'''
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
{{APIComment|'Get a list of all defined units in the repository.}}
  {{APIPrefix|Dim}} ListOfUnits() {{APIPrefix|As}} UnitInfo
  ListOfUnits = MyRepository.Unit.GetAllUnits()
{{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"