Repository.Xfmea.GetAllXfmeaFunctionsDictionary Method: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 9: Line 9:
===Parameters===
===Parameters===
''HID''
''HID''
:Integer. The Hierarchy ID or record ID of the parent item. (Required)
:Integer. The Hierarchy ID or record ID of the system hierarchy item. (Required)


''IncludeLinkedAnalyses''
''IncludeLinkedAnalyses''
Line 16: Line 16:


== Example ==
== Example ==
This example assumes that a system hierarchy item with a record ID# 1 exists in the first available project of the repository.  
This example assumes that system hierarchy items with FMEAs exists in the first available project of the repository.  
  '''VB.NET'''  
  '''VB.NET'''  
   
   
Line 24: Line 24:
   
   
   
   
  {{APIComment|'Open project #1 and get a dictionary of all FMEA functions associated with item #1.}}
  {{APIComment|'Open project #1 and get a dictionary of all FMEA functions associated with the first available system hierarchy item.}}
   {{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)   

Revision as of 00:00, 21 August 2015

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 system hierarchy item. (Required)

IncludeLinkedAnalyses

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


Example

This example assumes that system hierarchy items with FMEAs 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 the first available system hierarchy item. 
 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)