Repository.Xfmea.GetXfmeaEffect Method: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) mNo edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
| Line 2: | Line 2: | ||
<onlyinclude>Gets the | <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> | ||
==Syntax== | ==Syntax== | ||
| Line 9: | Line 9: | ||
===Parameters=== | ===Parameters=== | ||
''ID'' | ''ID'' | ||
:Required. Integer. The ID number of the | :Required. Integer. The ID number of the effect to retrieve. | ||
==Example== | ==Example== | ||
This example assumes that an | This example assumes that an effect with ID#1 exists in a repository. | ||
'''VBA''' | '''VBA''' | ||
| Line 21: | Line 21: | ||
{{APIComment|'Get | {{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) | ||
| Line 36: | Line 36: | ||
{{APIComment|'Get | {{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) | ||
Revision as of 22:39, 11 September 2015
 |
Member of: SynthesisAPI10.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)