Repository.Xfmea.GetAllXfmeaFunctionsDictionary Method

From ReliaWiki
Revision as of 22:24, 13 November 2015 by Kate Racaza (talk | contribs)
Jump to navigation Jump to search
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 

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ... 


 '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)