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
 
(4 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}




<onlyinclude>Gets the FMEA cause with the designated ID number and returns it as an '''[[XfmeaCause Class|XfmeaCause]]''' object. Returns nothing if the cause does not exist or is not in the current project.</onlyinclude>
<onlyinclude>Returns an '''[[XfmeaCause Class|XfmeaCause]]''' object that represents a given FMEA cause in the current project. Returns nothing if the cause 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 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'''
   
   
  {{APIComment|'Add code to connect to a Synthesis repository.}}
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
  {{APIComment|'Get cause ID#1 from the first project in the repository.}}
  {{APIComment|'Get FMEA cause #1 from project #1.}}
  {{APIPrefix|Dim}} ACause {{APIPrefix|As}} XfmeaCause
  {{APIPrefix|Dim}} ACause {{APIPrefix|As}} XfmeaCause
  MyRepository.Project.SetCurrentProject(1)
  MyRepository.Project.SetCurrentProject(1)
  {{APIPrefix|Set}} ACause = MyRepository.Xfmea.GetXfmeaCause(1)
  {{APIPrefix|Set}} ACause = MyRepository.Xfmea.GetXfmeaCause(1)
   
   
  {{APIComment|'Output sample: Display the description of the cause.}}
  {{APIComment|'Output sample: Display the description of the cause.}}
  MsgBox (ACause.Dsc)
  MsgBox (ACause.Dsc)


  '''VB.NET'''
  '''VB.NET'''
   
   
  {{APIComment|'Add code to connect to a Synthesis repository.}}
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
 
  {{APIComment|'Get cause ID#1 from the first project in the repository.}}
  {{APIComment|'Get FMEA cause #1 from project #1.}}
  {{APIPrefix|Dim}} ACause {{APIPrefix|As}} XfmeaCause
  {{APIPrefix|Dim}} ACause {{APIPrefix|As}} XfmeaCause
  MyRepository.Project.SetCurrentProject(1)
  MyRepository.Project.SetCurrentProject(1)
  ACause = MyRepository.Xfmea.GetXfmeaCause(1)
  ACause = MyRepository.Xfmea.GetXfmeaCause(1)
   
   
  {{APIComment|'Output sample: Display the description of the cause.}}
  {{APIComment|'Output sample: Display the description of the cause.}}
  MsgBox (ACause.Dsc)
  MsgBox (ACause.Dsc)

Latest revision as of 18:44, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Returns an XfmeaCause object that represents a given FMEA cause in the current project. 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

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
 
 '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

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
  
 '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)