Repository.Xfmea.GetAllXfmeaEffects Method: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:




<onlyinclude>Gets a list of effects associated with a failure. Returns an '''[[XfmeaEffect Class|XfmeaEffect]]''' object that represents the effects.</onlyinclude>   
<onlyinclude>Gets an array of '''[[XfmeaEffect Class|XfmeaEffect]]''' objects that represent the effects associated with a 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.  

Revision as of 15:21, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Gets 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)