Repository.Xfmea.GetAllXfmeaFunctionsDictionary Method: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 19: Line 19:
  '''VB.NET'''  
  '''VB.NET'''  
   
   
  {{APIComment|'Add code to connect to a Synthesis repository.}}
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
  {{APIComment|'Open project #1 and get a dictionary of all FMEA functions associated with system hierarchy item #1.}}
  {{APIComment|'Open project #1 and get a dictionary of all FMEA functions associated with system hierarchy item #1.}}
  {{APIPrefix|Dim}} Dict {{APIPrefix|As}} Dictionary (of Integer, XfmeaFunction)   
  {{APIPrefix|Dim}} Dict {{APIPrefix|As}} Dictionary (of Integer, XfmeaFunction)   
  MyRepository.Project.SetCurrentProject(1)   
  MyRepository.Project.SetCurrentProject(1)   
  Dict = MyRepository.Xfmea.GetAllXfmeaFunctionsDictionary(1, {{APIPrefix|True)}}
  Dict = MyRepository.Xfmea.GetAllXfmeaFunctionsDictionary(1, {{APIPrefix|True)}}
   
   
  {{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 18:07, 8 April 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Gets a dictionary of the FMEA functions associated with a system hierarchy item. Returns a Dictionary(Of Integer, XfmeaFunction) object, where the keys are the ID numbers of the functions. (VB.NET only)

Syntax

.Xfmea.GetAllXfmeaFunctionsDictionary(HID,IncludeLinkedAnalyses)

Parameters

HID

Required. Integer. The record ID of the system hierarchy item.

IncludeLinkedAnalyses

Required. Boolean. Indicates whether to include linked FMEAs in the dictionary.


Example

This example assumes that system hierarchy items with FMEAs exists in the first available project of a repository.

VB.NET 

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
 
 'Open project #1 and get a dictionary of all FMEA functions associated with system hierarchy item #1. 
  Dim Dict As Dictionary (of Integer, XfmeaFunction)  
  MyRepository.Project.SetCurrentProject(1)  
  Dict = MyRepository.Xfmea.GetAllXfmeaFunctionsDictionary(1, True)

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