Repository.Xfmea.GetXfmeaFailure Method: Difference between revisions

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




<onlyinclude>Gets the FMEA failure with the designated ID number and returns it as an '''[[XfmeaFailure Class|XfmeaFailure]]''' object. Returns nothing if the failure does not exist or is not in the current project.</onlyinclude>
<onlyinclude>Gets the failure with the designated ID number and returns it as an '''[[XfmeaFailure Class|XfmeaFailure]]''' object. Returns nothing if the failure does not exist or is not in the current project.</onlyinclude>


==Syntax==
==Syntax==
Line 9: Line 9:
===Parameters===
===Parameters===
''ID''
''ID''
:Required. Integer. The ID number of the FMEA failure to retrieve.  
:Required. Integer. The ID number of the failure to retrieve.  




==Example==
==Example==
This example assumes that an FMEA failure with ID#1 exists in a repository.
This example assumes that a failure with ID#1 exists in a repository.
  '''VBA'''
  '''VBA'''
   
   
Line 21: Line 21:
   
   
   
   
  {{APIComment|'Get FMEA failure #1 from project #1.}}
  {{APIComment|'Get failure #1 from project #1.}}
   {{APIPrefix|Dim}} AFailure {{APIPrefix|As}} XfmeaFailure
   {{APIPrefix|Dim}} AFailure {{APIPrefix|As}} XfmeaFailure
   MyRepository.Project.SetCurrentProject(1)
   MyRepository.Project.SetCurrentProject(1)
Line 36: Line 36:
    
    
   
   
  {{APIComment|'Get FMEA failure #1 from project #1.}}
  {{APIComment|'Get failure #1 from project #1.}}
   {{APIPrefix|Dim}} AFailure {{APIPrefix|As}} XfmeaFailure
   {{APIPrefix|Dim}} AFailure {{APIPrefix|As}} XfmeaFailure
   MyRepository.Project.SetCurrentProject(1)
   MyRepository.Project.SetCurrentProject(1)

Revision as of 22:40, 11 September 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Gets the failure with the designated ID number and returns it as an XfmeaFailure object. Returns nothing if the failure does not exist or is not in the current project.

Syntax

.Xfmea.GetXfmeaFailure(ID)

Parameters

ID

Required. Integer. The ID number of the failure to retrieve.


Example

This example assumes that a failure with ID#1 exists in a repository.

VBA

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ... 


 'Get failure #1 from project #1. 
 Dim AFailure As XfmeaFailure
 MyRepository.Project.SetCurrentProject(1)
 Set AFailure = MyRepository.Xfmea.GetXfmeaFailure(1)

 'Output sample: Display the description of the failure. 
 MsgBox (AFailure.Dsc)
VB.NET

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ... 
 

 'Get failure #1 from project #1. 
 Dim AFailure As XfmeaFailure
 MyRepository.Project.SetCurrentProject(1)
 AFailure = MyRepository.Xfmea.GetXfmeaFailure(1)

 'Output sample: Display the description of the failure. 
 MsgBox (AFailure.Dsc)