Repository.Xfmea.GetXfmeaFunction Method: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(One intermediate revision by the same user not shown)
Line 2: Line 2:




<onlyinclude>Returns an '''[[XfmeaFunction Class|XfmeaFunction]]''' object that represents a given FMEA function in the current project. Returns nothing if the function does not exist or is not in the current project.</onlyinclude>
<onlyinclude>Returns an '''[[XfmeaFunction Class|XfmeaFunction]]''' object that represents a given FMEA function in the current project. Returns nothing if the FMEA 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 function to retrieve.  
:Required. Integer. The ID number of the FMEA function to retrieve.  




==Example==
==Example==
This example assumes that a function with ID#1 exists in a repository.
This example assumes that an FMEA function with ID#1 exists in a repository.
  '''VBA'''
  '''VBA'''
   
   
Line 20: Line 20:
   MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
   MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
   
   
  {{APIComment|'Get function #1 from project #1.}}
  {{APIComment|'Get FMEA 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)
   {{APIPrefix|Set}} Function1 = MyRepository.Xfmea.GetXfmeaFunction(1)
   {{APIPrefix|Set}} Function1 = MyRepository.Xfmea.GetXfmeaFunction(1)
   
   
  {{APIComment|'Output sample: Display the description of the function.}}
  {{APIComment|'Output sample: Display the description of the FMEA function.}}
   MsgBox (Function1.Dsc)
   MsgBox (Function1.Dsc)


Line 34: Line 34:
   MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
   MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
    
    
  {{APIComment|'Get function #1 from project #1.}}
  {{APIComment|'Get FMEA 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)
   Function1 = MyRepository.Xfmea.GetXfmeaFunction(1)
   Function1 = MyRepository.Xfmea.GetXfmeaFunction(1)
   
   
  {{APIComment|'Output sample: Display the description of the function.}}
  {{APIComment|'Output sample: Display the description of the FMEA function.}}
   MsgBox (Function1.Dsc)
   MsgBox (Function1.Dsc)

Latest revision as of 18:49, 22 August 2016

APIWiki.png


Member of: SynthesisAPI.Repository


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

Syntax

.Xfmea.GetXfmeaFunction(ID)

Parameters

ID

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


Example

This example assumes that an FMEA function 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 FMEA 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 FMEA function. 
  MsgBox (Function1.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 FMEA 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 FMEA function. 
  MsgBox (Function1.Dsc)