Repository.Xfmea.GetXfmeaEffect Method

Member of: SynthesisAPI.Repository

Gets the effect with the designated ID number and returns it as an XfmeaEffect object. 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

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


 '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

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

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