Repository.Xfmea.GetXfmeaFailure Method: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
 
(4 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 Xfmea failure with the designated ID number and returns it as an '''[[XfmeaFailure Class|XfmeaFailure]]''' object. Returns nothing if the failure does not exist or is not in the current project.</onlyinclude>
<onlyinclude>Returns an '''[[XfmeaFailure Class|XfmeaFailure]]''' object that represents a given FMEA failure in the current project. Returns nothing if the failure 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 FMEA failure to retrieve.  
:Required. Integer. The ID number of the failure to retrieve.  




==Example==
==Example==
This example assumes that an FMEA failure with ID#1 exists in a repository.
This example assumes that a failure 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 failure #1 from project #1.}}
  {{APIComment|'Get FMEA failure #1 from project #1.}}
  {{APIPrefix|Dim}} AFailure {{APIPrefix|As}} XfmeaFailure
  {{APIPrefix|Dim}} AFailure {{APIPrefix|As}} XfmeaFailure
  MyRepository.Project.SetCurrentProject(1)
  MyRepository.Project.SetCurrentProject(1)
  {{APIPrefix|Set}} AFailure = MyRepository.Xfmea.GetXfmeaFailure(1)
  {{APIPrefix|Set}} AFailure = MyRepository.Xfmea.GetXfmeaFailure(1)
   
   
  {{APIComment|'Output sample: Display the description of the failure.}}
  {{APIComment|'Output sample: Display the description of the failure.}}
  MsgBox (AFailure.Dsc)
  MsgBox (AFailure.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 FMEA failure #1 from project #1.}}
  {{APIComment|'Get failure #1 from project #1.}}
  {{APIPrefix|Dim}} AFailure {{APIPrefix|As}} XfmeaFailure
  {{APIPrefix|Dim}} AFailure {{APIPrefix|As}} XfmeaFailure
  MyRepository.Project.SetCurrentProject(1)
  MyRepository.Project.SetCurrentProject(1)
  AFailure = MyRepository.Xfmea.GetXfmeaFailure(1)
  AFailure = MyRepository.Xfmea.GetXfmeaFailure(1)
   
   
  {{APIComment|'Output sample: Display the description of the failure.}}
  {{APIComment|'Output sample: Display the description of the failure.}}
  MsgBox (AFailure.Dsc)
  MsgBox (AFailure.Dsc)

Latest revision as of 18:45, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


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

Syntax

.Xfmea.GetXfmeaFailure(ID)

Parameters

ID

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


Example

This example assumes that a failure 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 failure #1 from project #1. 
  Dim AFailure As XfmeaFailure
  MyRepository.Project.SetCurrentProject(1)
  Set AFailure = MyRepository.Xfmea.GetXfmeaFailure(1)

 'Output sample: Display the description of the failure. 
  MsgBox (AFailure.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 failure #1 from project #1. 
  Dim AFailure As XfmeaFailure
  MyRepository.Project.SetCurrentProject(1)
  AFailure = MyRepository.Xfmea.GetXfmeaFailure(1)

 'Output sample: Display the description of the failure. 
  MsgBox (AFailure.Dsc)