Repository.Xfmea.GetAllXfmeaEffects Method

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


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)