Repository.Xfmea.GetAllXfmeaEffectsDictionary Method: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) (Created page with '{{Template:API}}{{Template:APIBreadcrumb|10|.Repository}} <onlyinclude>Gets a dictionary of the effects associated with an FMEA failure. Returns a '''Dicti…') |
Kate Racaza (talk | contribs) No edit summary |
||
Line 2: | Line 2: | ||
<onlyinclude>Gets a dictionary of the effects associated with | <onlyinclude>Gets a dictionary of the effects associated with a failure. Returns a '''Dictionary(Of Integer, [[XfmeaEffect Class|XfmeaEffect]])''' object, where the keys are the ID numbers of the effects. (VB.NET only)</onlyinclude> | ||
Note that grouped effects are counted as a single entry in the dictionary. | Note that grouped effects are counted as a single entry in the dictionary. | ||
Line 11: | Line 11: | ||
===Parameters=== | ===Parameters=== | ||
''FailureID'' | ''FailureID'' | ||
:Required. Integer. The record ID of the | :Required. Integer. The record ID of the failure. | ||
Line 24: | Line 24: | ||
{{APIComment|'Open project #1 and get a dictionary of all effects associated with | {{APIComment|'Open project #1 and get a dictionary of all effects associated with failure #1.}} | ||
{{APIPrefix|Dim}} Dict {{APIPrefix|As}} Dictionary (of Integer, XfmeaEffect) | {{APIPrefix|Dim}} Dict {{APIPrefix|As}} Dictionary (of Integer, XfmeaEffect) | ||
MyRepository.Project.SetCurrentProject(1) | MyRepository.Project.SetCurrentProject(1) |
Revision as of 22:36, 11 September 2015
Member of: SynthesisAPI10.Repository
Gets a dictionary of the effects associated with a failure. Returns a Dictionary(Of Integer, XfmeaEffect) object, where the keys are the ID numbers of the effects. (VB.NET only)
Note that grouped effects are counted as a single entry in the dictionary.
Syntax
.Xfmea.GetAllXfmeaEffectsDictionary(FailureID)
Parameters
FailureID
- Required. Integer. The record ID of the failure.
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 effects associated with failure #1. Dim Dict As Dictionary (of Integer, XfmeaEffect) MyRepository.Project.SetCurrentProject(1) Dict = MyRepository.Xfmea.GetAllXfmeaEffectsDictionary(1) 'Output sample: Display the number of entries in the dictionary. MsgBox(Dict.Count)