Repository.Xfmea.GetAllItemsInSystemHierarchyDictionary Method: Difference between revisions

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




<onlyinclude>Gets a dictionary of system hierarchy items associated with a project. Returns a '''Dictionary(Of Integer, [[XfmeaItem Class|XfmeaItem]])''' object, where the keys are the ID numbers of the system hierarchy items. (VB.NET only)</onlyinclude>
<onlyinclude>Returns a dictionary object that contains all available system hierarchy items in the current project. The dictionary syntax is '''Dictionary(Of Integer, XfmeaItem)''', where the ID numbers are the keys, and the [[XfmeaItem Class|XfmeaItem]] objects that represent the system hierarchy items are the associated values. (VB.NET only)</onlyinclude>


== Syntax ==
== Syntax ==
Line 15: Line 15:
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
   MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
{{APIComment|'Set the first project in the repository as the current project.}}
  MyRepository.Project.SetCurrentProject(1)
    
    
  {{APIComment|'Get a dictionary of all system hierarchy items in project #1.}}
  {{APIComment|'Declare a new dictionary object.}}
   {{APIPrefix|Dim}} Dict {{APIPrefix|As}} Dictionary (of Integer, XfmeaItem)   
   {{APIPrefix|Dim}} Dict {{APIPrefix|As}} Dictionary (of Integer, XfmeaItem)   
  MyRepository.Project.SetCurrentProject(1) 
{{APIComment|'Add values to the dictionary.}}
   Dict = MyRepository.Xfmea.GetAllItemsInSystemHierarchyDictionary()
   Dict = MyRepository.Xfmea.GetAllItemsInSystemHierarchyDictionary()
   
   
  {{APIComment|'Output sample: Display the number of entries in the dictionary. }}
  {{APIComment|'Output sample: Display the number of entries in the dictionary. }}
   MsgBox(Dict.Count)
   MsgBox(Dict.Count)

Revision as of 17:59, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Returns a dictionary object that contains all available system hierarchy items in the current project. The dictionary syntax is Dictionary(Of Integer, XfmeaItem), where the ID numbers are the keys, and the XfmeaItem objects that represent the system hierarchy items are the associated values. (VB.NET only)

Syntax

.Xfmea.GetAllItemsInSystemHierarchyDictionary()


Example

This example assumes that system hierarchy items exist in the first available project of the repository.

VB.NET 

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")

 'Set the first project in the repository as the current project. 
  MyRepository.Project.SetCurrentProject(1)
 
 'Declare a new dictionary object. 
  Dim Dict As Dictionary (of Integer, XfmeaItem)  

 'Add values to the dictionary. 
  Dict = MyRepository.Xfmea.GetAllItemsInSystemHierarchyDictionary()

 'Output sample: Display the number of entries in the dictionary.  
  MsgBox(Dict.Count)