Repository.Xfmea.GetAllXfmeaFunctionsDictionary Method

From ReliaWiki
Revision as of 22:49, 20 August 2015 by Kate Racaza (talk | contribs)
Jump to navigation Jump to search
APIWiki.png


Member of: SynthesisAPI10.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

Integer. The Hierarchy ID or record ID of the parent item. (Required)

IncludeLinkedAnalyses

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


Example

This example assumes that a system hierarchy item with a record ID# 1 exists in the first available project of the 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 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 FMEA functions associated with the item.  
 MsgBox(Dict.Count)