Repository.Xfmea.UpdateXfmeaFunction Method: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
(Created page with '{{Template:API}}{{Template:APIBreadcrumb|10|.Repository}} <onlyinclude>Applies any updates made to a XfmeaFunction object to the Sy…')
 
No edit summary
Line 2: Line 2:




<onlyinclude>Applies any updates made to a [[XfmeaFunction Class|XfmeaFunction]] object to the Synthesis repository. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude>   
<onlyinclude>Applies any updates made to an existing Xfmea function. Returns a '''Boolean''' value; when true, indicates that changes have been saved in the Synthesis repository.</onlyinclude>   


== Syntax ==
== Syntax ==
Line 30: Line 30:
   MyFunction.Dsc = {{APIString|"New_Description"}}
   MyFunction.Dsc = {{APIString|"New_Description"}}
   
   
  {{APIComment|'Apply the change to the Synthesis repository.}}
  {{APIComment|'Apply the update to the function. Changes are recorded in the Synthesis repository.}}
   {{APIPrefix|Call}} MyRepository.Xfmea.UpdateXfmeaFunction(MyFunction)
   {{APIPrefix|Call}} MyRepository.Xfmea.UpdateXfmeaFunction(MyFunction)


Line 48: Line 48:
   MyFunction.Dsc = {{APIString|"New_Description"}}
   MyFunction.Dsc = {{APIString|"New_Description"}}
   
   
  {{APIComment|'Apply the change to the Synthesis repository.}}
  {{APIComment|'Apply the update to the function. Changes are recorded in the Synthesis repository.}}
   MyRepository.Xfmea.UpdateXfmeaFunction(MyFunction)
   MyRepository.Xfmea.UpdateXfmeaFunction(MyFunction)

Revision as of 20:33, 24 August 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Applies any updates made to an existing Xfmea function. Returns a Boolean value; when true, indicates that changes have been saved in the Synthesis repository.

Syntax

.Xfmea.UpdateXfmeaFunction(func)

Parameters

func

Required. The XfmeaFunction object to be updated.


Example

This example assumes that an Xfmea function with ID #1 exists in the repository.

VBA

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

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

 'Change the function's description to "New_Description." 
 MyFunction.Dsc = "New_Description"

 'Apply the update to the function. Changes are recorded in the Synthesis repository. 
 Call MyRepository.Xfmea.UpdateXfmeaFunction(MyFunction)
VB.NET

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

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

 'Change the function's description to "New_Description." 
 MyFunction.Dsc = "New_Description"

 'Apply the update to the function. Changes are recorded in the Synthesis repository. 
 MyRepository.Xfmea.UpdateXfmeaFunction(MyFunction)