Repository.Xfmea.GetXfmeaCause Method: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
(Created page with '{{Template:API}}{{Template:APIBreadcrumb|10|.Repository}} <onlyinclude>Gets the FMEA cause with the designated ID number and returns it as an '''[[XfmeaCau…')
 
No edit summary
Line 9: Line 9:
===Parameters===
===Parameters===
''ID''
''ID''
:Required. Integer. The ID number of the FMEA cause to retrieve.  
:Required. Integer. The record ID number of the cause to retrieve.  




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

Revision as of 21:44, 11 September 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


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

Syntax

.Xfmea.GetXfmeaCause(ID)

Parameters

ID

Required. Integer. The record ID number of the cause to retrieve.


Example

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

VBA

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


 'Get cause ID#1 from the first project in the repository. 
 Dim ACause As XfmeaCause
 MyRepository.Project.SetCurrentProject(1)
 Set ACause = MyRepository.Xfmea.GetXfmeaCause(1)

 'Output sample: Display the description of the cause. 
 MsgBox (ACause.Dsc)
VB.NET

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

 'Get cause ID#1 from the first project in the repository. 
 Dim ACause As XfmeaCause
 MyRepository.Project.SetCurrentProject(1)
 ACause = MyRepository.Xfmea.GetXfmeaCause(1)

 'Output sample: Display the description of the cause. 
 MsgBox (ACause.Dsc)