Repository.Xfmea.GetXfmeaFunction Method: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 2: Line 2:




<onlyinclude>Gets the Xfmea function with the designated ID number and returns it as a '''[[XfmeaFunction Class|XfmeaFunction]]''' object. Returns nothing if the function does not exist or is not in the current project.</onlyinclude>
<onlyinclude>Gets the FMEA function with the designated ID number and returns it as a '''[[XfmeaFunction Class|XfmeaFunction]]''' object. Returns nothing if the function 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 Xfmea function to retrieve.  
:Required. Integer. The ID number of the function to retrieve.  




==Example==
==Example==
This example assumes that an Xfmea function with ID#1 exists in a repository.
This example assumes that a function with ID#1 exists in a repository.
  '''VBA'''
  '''VBA'''
   
   
Line 21: Line 21:
   
   
   
   
  {{APIComment|'Get Xfmea function #1 from project #1.}}
  {{APIComment|'Get function #1 from project #1.}}
   {{APIPrefix|Dim}} Function1 {{APIPrefix|As}} XfmeaFunction
   {{APIPrefix|Dim}} Function1 {{APIPrefix|As}} XfmeaFunction
   MyRepository.Project.SetCurrentProject(1)
   MyRepository.Project.SetCurrentProject(1)
Line 36: Line 36:
    
    
   
   
  {{APIComment|'Get Xfmea function #1 from project #1.}}
  {{APIComment|'Get function #1 from project #1.}}
   {{APIPrefix|Dim}} Function1 {{APIPrefix|As}} XfmeaFunction
   {{APIPrefix|Dim}} Function1 {{APIPrefix|As}} XfmeaFunction
   MyRepository.Project.SetCurrentProject(1)
   MyRepository.Project.SetCurrentProject(1)

Revision as of 22:40, 11 September 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


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

Syntax

.Xfmea.GetXfmeaFunction(ID)

Parameters

ID

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


Example

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

VBA

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


 'Get function #1 from project #1. 
 Dim Function1 As XfmeaFunction
 MyRepository.Project.SetCurrentProject(1)
 Set Function1 = MyRepository.Xfmea.GetXfmeaFunction(1)

 'Output sample: Display the description of the function. 
 MsgBox (Function1.Dsc)
VB.NET

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

 'Get function #1 from project #1. 
 Dim Function1 As XfmeaFunction
 MyRepository.Project.SetCurrentProject(1)
 Function1 = MyRepository.Xfmea.GetXfmeaFunction(1)

 'Output sample: Display the description of the function. 
 MsgBox (Function1.Dsc)