Repository.Xfmea.GetXfmeaEffect Method: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(2 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 effect with the designated ID number and returns it as an '''[[XfmeaEffect Class|XfmeaEffect]]''' object. Returns nothing if the effect does not exist or is not in the current project.</onlyinclude>
<onlyinclude>Returns an '''[[XfmeaEffect Class|XfmeaEffect]]''' object that represents a given FMEA effect in the current project. Returns nothing if the effect does not exist or is not in the current project.</onlyinclude>


==Syntax==
==Syntax==
Line 15: Line 15:
This example assumes that an effect with ID#1 exists in a repository.
This example assumes that an effect 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 effect #1 from project #1.}}
  {{APIComment|'Get effect #1 from project #1.}}
  {{APIPrefix|Dim}} AEffect {{APIPrefix|As}} XfmeaEffect
  {{APIPrefix|Dim}} AEffect {{APIPrefix|As}} XfmeaEffect
  MyRepository.Project.SetCurrentProject(1)
  MyRepository.Project.SetCurrentProject(1)
  {{APIPrefix|Set}} AEffect = MyRepository.Xfmea.GetXfmeaEffect(1)
  {{APIPrefix|Set}} AEffect = MyRepository.Xfmea.GetXfmeaEffect(1)
   
   
  {{APIComment|'Output sample: Display the description of the effect.}}
  {{APIComment|'Output sample: Display the description of the effect.}}
  MsgBox (AEffect.Dsc)
  MsgBox (AEffect.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 effect #1 from project #1.}}
  {{APIComment|'Get effect #1 from project #1.}}
  {{APIPrefix|Dim}} AEffect {{APIPrefix|As}} XfmeaEffect
  {{APIPrefix|Dim}} AEffect {{APIPrefix|As}} XfmeaEffect
  MyRepository.Project.SetCurrentProject(1)
  MyRepository.Project.SetCurrentProject(1)
  AEffect = MyRepository.Xfmea.GetXfmeaEffect(1)
  AEffect = MyRepository.Xfmea.GetXfmeaEffect(1)
   
   
  {{APIComment|'Output sample: Display the description of the effect.}}
  {{APIComment|'Output sample: Display the description of the effect.}}
  MsgBox (AEffect.Dsc)
  MsgBox (AEffect.Dsc)

Latest revision as of 18:44, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Returns an XfmeaEffect object that represents a given FMEA effect in the current project. Returns nothing if the effect does not exist or is not in the current project.

Syntax

.Xfmea.GetXfmeaEffect(ID)

Parameters

ID

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


Example

This example assumes that an effect 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 effect #1 from project #1. 
  Dim AEffect As XfmeaEffect
  MyRepository.Project.SetCurrentProject(1)
  Set AEffect = MyRepository.Xfmea.GetXfmeaEffect(1)

 'Output sample: Display the description of the effect. 
  MsgBox (AEffect.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 effect #1 from project #1. 
  Dim AEffect As XfmeaEffect
  MyRepository.Project.SetCurrentProject(1)
  AEffect = MyRepository.Xfmea.GetXfmeaEffect(1)

 'Output sample: Display the description of the effect. 
  MsgBox (AEffect.Dsc)