Repository.Xfmea.UpdateXfmeaEffect Method: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(2 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>Applies any changes made to an existing effect. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>   
<onlyinclude>Updates the properties of a given FMEA effect in the current project. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude>   


== Syntax ==
== Syntax ==
Line 9: Line 9:
=== Parameters ===
=== Parameters ===
''Effect''
''Effect''
:Required. The [[XfmeaEffect Class|XfmeaEffect]] object to be updated.
:Required. The [[XfmeaEffect Class|XfmeaEffect]] object that represents the FMEA effect to be updated.




Line 17: Line 17:
  '''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 effect #1 from project #1.}}
  {{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)
  {{APIPrefix|Set}} AEffect = MyRepository.Xfmea.GetXfmeaEffect(1)
  {{APIPrefix|Set}} AEffect = MyRepository.Xfmea.GetXfmeaEffect(1)
   
   
  {{APIComment|'Change the effect's description to "New_Description."}}
  {{APIComment|'Change the effect's description to "New_Description."}}
  AEffect.Dsc = {{APIString|"New_Description"}}
  AEffect.Dsc = {{APIString|"New_Description"}}
   
   
  {{APIComment|'Apply the change to the effect. Changes are recorded in the Synthesis repository.}}
  {{APIComment|'Send the change to the Synthesis repository.}}
  {{APIPrefix|Call}} MyRepository.Xfmea.UpdateXfmeaEffect(AEffect)
  {{APIPrefix|Call}} MyRepository.Xfmea.UpdateXfmeaEffect(AEffect)


  '''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 effect #1 from project #1.}}
  {{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)
  AEffect = MyRepository.Xfmea.GetXfmeaEffect(1)
  AEffect = MyRepository.Xfmea.GetXfmeaEffect(1)
   
   
  {{APIComment|'Change the effect's description to "New_Description."}}
  {{APIComment|'Change the effect's description to "New_Description."}}
  AEffect.Dsc = {{APIString|"New_Description"}}
  AEffect.Dsc = {{APIString|"New_Description"}}
   
   
  {{APIComment|'Apply the change to the effect. Changes are recorded in the Synthesis repository.}}
  {{APIComment|'Send the change to the Synthesis repository.}}
  MyRepository.Xfmea.UpdateXfmeaEffect(AEffect)
  MyRepository.Xfmea.UpdateXfmeaEffect(AEffect)

Latest revision as of 18:49, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Updates the properties of a given FMEA effect in the current project. Returns a Boolean value; when true, indicates a successful update.

Syntax

.Xfmea.UpdateXfmeaEffect(Effect)

Parameters

Effect

Required. The XfmeaEffect object that represents the FMEA effect to be updated.


Example

This example assumes that an effect with ID #1 exists in the first available project of 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 effect #1 from project #1. 
  Dim AEffect As XfmeaEffect
  MyRepository.Project.SetCurrentProject(1)
  Set AEffect = MyRepository.Xfmea.GetXfmeaEffect(1)

 'Change the effect's description to "New_Description." 
  AEffect.Dsc = "New_Description"

 'Send the change to the Synthesis repository. 
  Call MyRepository.Xfmea.UpdateXfmeaEffect(AEffect)
VB.NET

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
  
 'Get effect #1 from project #1. 
  Dim AEffect As XfmeaEffect
  MyRepository.Project.SetCurrentProject(1)
  AEffect = MyRepository.Xfmea.GetXfmeaEffect(1)

 'Change the effect's description to "New_Description." 
  AEffect.Dsc = "New_Description"

 'Send the change to the Synthesis repository. 
  MyRepository.Xfmea.UpdateXfmeaEffect(AEffect)