Repository.Xfmea.GetAllXfmeaEffects Method: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
| Line 2: | Line 2: | ||
<onlyinclude>Gets a list of effects associated with | <onlyinclude>Gets a list of effects associated with a failure. Returns an '''[[XfmeaEffect Class|XfmeaEffect]]''' object array that contains all the effects in that failure.</onlyinclude> | ||
Note that grouped effects are counted as a single element in the array. | Note that grouped effects are counted as a single element in the array. | ||
| Line 11: | Line 11: | ||
===Parameters=== | ===Parameters=== | ||
''FailureID'' | ''FailureID'' | ||
:Required. Integer. The record ID of the | :Required. Integer. The record ID of the failure. | ||
== Example == | == Example == | ||
This example assumes that system hierarchy items with | This example assumes that system hierarchy items with failures exist in the first available project of a repository. | ||
'''VBA|VB.NET''' | '''VBA|VB.NET''' | ||
| Line 24: | Line 24: | ||
{{APIComment|'Get a list of all effects associated with | {{APIComment|'Get a list of all effects associated with failure #1 in project #1.}} | ||
{{APIPrefix|Dim}} ListofEffects() {{APIPrefix|As}} XfmeaEffect | {{APIPrefix|Dim}} ListofEffects() {{APIPrefix|As}} XfmeaEffect | ||
MyRepository.Project.SetCurrentProject (1) | MyRepository.Project.SetCurrentProject (1) | ||
Revision as of 22:36, 11 September 2015
 |
Member of: SynthesisAPI10.Repository
Gets a list of effects associated with a failure. Returns an XfmeaEffect object array that contains all the effects in that failure.
Note that grouped effects are counted as a single element in the array.
Syntax
.Xfmea.GetAllXfmeaEffects(FailureID)
Parameters
FailureID
- Required. Integer. The record ID of the failure.
Example
This example assumes that system hierarchy items with failures exist in the first available project of a repository.
VBA|VB.NET 'Add code to connect to a Synthesis repository. Dim MyRepository As New Repository ... 'Get a list of all effects associated with failure #1 in project #1. Dim ListofEffects() As XfmeaEffect MyRepository.Project.SetCurrentProject (1) ListofEffects = MyRepository.Xfmea.GetAllXfmeaEffects(1) 'Output sample: Display the number of elements in the array. Dim NumberofElements As Integer NumberofElements = UBound(ListofEffects) - LBound(ListofEffects) + 1 MsgBox (NumberofElements)