Repository.Xfmea.GetAllXfmeaEffects Method

From ReliaWiki
Revision as of 18:32, 9 June 2016 by Kate Racaza (talk | contribs)
Jump to navigation Jump to search
APIWiki.png


Member of: SynthesisAPI.Repository


Returns an array of XfmeaEffect objects that represent the effects associated with a 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
 
 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
  
 '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 effects. 
  Dim NumberofElements As Integer
  NumberofElements = UBound(ListofEffects) - LBound(ListofEffects) + 1
  MsgBox (NumberofElements)