Repository.Xfmea.GetAllXfmeaFunctionsDictionary Method: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
(Created page with '{{InProgress}}{{Template:API}}{{Template:APIBreadcrumb|10|.Repository}} <!-- <onlyinclude>Gets a dictionary of the Xfmea functions in the current project. R…')
 
No edit summary
Line 1: Line 1:
{{InProgress}}{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}
{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}


<!--
 
<onlyinclude>Gets a dictionary of the Xfmea functions in the current project. Returns a '''Dictionary(Of Integer, [[XfmeaItem Class|XfmeaFunction]])''' object, where the keys are the ID numbers of the functions.</onlyinclude>
<onlyinclude>Gets a dictionary of the FMEA functions associated with a system hierarchy item. Returns a '''Dictionary(Of Integer, [[XfmeaItem Class|XfmeaFunction]])''' object, where the keys are the ID numbers of the functions. (VB.NET only)</onlyinclude>


== Syntax ==
== Syntax ==
  '''.Xfmea.GetAllXfmeaFunctionsDictionary'''(''HID,IncludeLikedAnalises'')
  '''.Xfmea.GetAllXfmeaFunctionsDictionary'''(''HID,IncludeLinkedAnalyses'')


===Parameters===
===Parameters===
''HID''
''HID''
:xxx??
:Integer. The Hierarchy ID or record ID of the parent item. (Required)
''IncludeLinkedAnalises''
 
:Boolean.??
''IncludeLinkedAnalyses''
:Boolean. Indicates whether to include linked FMEAs in the dictionary. (Required)




== Example ==
== Example ==
This example assumes that xxx exist in the first available project of the repository.  
This example assumes that a system hierarchy item with a record ID# 1 exists in the first available project of the repository.  
  '''VB.NET'''  
  '''VB.NET'''  
   
   
Line 23: Line 24:
   
   
   
   
  {{APIComment|'Get a dictionary of all Xfmea functions in project #1.}}
  {{APIComment|'Open project #1 and get a dictionary of all FMEA functions associated with 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()
   Dict = MyRepository.Xfmea.GetAllXfmeaFunctionsDictionary(1, True)
   
   
  {{APIComment|'Output sample: Display the number of Xfmea functions in the project. }}
  {{APIComment|'Output sample: Display the number of FMEA functions associated with the item. }}
   MsgBox(Dict.Count)
   MsgBox(Dict.Count)
-->

Revision as of 22:49, 20 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 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)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Xfmea.GetAllXfmeaFunctionsDictionary_Method&oldid=60464"