Repository.URD.UpdateURD: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}
{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}


<onlyinclude>Updates the properties of an existing URD in the current project. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude>   
 
<onlyinclude>Applies any changes made to an existing URD. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>   


== Syntax ==
== Syntax ==
Line 7: Line 8:
=== Parameters ===
=== Parameters ===
''urd''
''urd''
:The [[CURD Class|cURD]] object to be updated.
:Required. The [[CURD Class|cURD]] object to be updated.




== Example ==
== Example ==
This example assumes that a URD with ID#1 exists in the repository.
This example assumes that a URD with ID #1 exists in the first available project in a repository.


  '''VBA'''
  '''VBA'''
Line 28: Line 29:
   MyURD.Name = {{APIString|"New_Name"}}
   MyURD.Name = {{APIString|"New_Name"}}
   
   
  {{APIComment|'Apply the update to the URD. Changes will be reflected in the repository.}}
  {{APIComment|'Apply the change to the URD. Changes are recorded in the Synthesis repository.}}
   {{APIPrefix|Call}} MyRepository.URD.UpdateURD(MyURD)
   {{APIPrefix|Call}} MyRepository.URD.UpdateURD(MyURD)


Line 46: Line 47:
   MyURD.Name = {{APIString|"New_Name"}}
   MyURD.Name = {{APIString|"New_Name"}}
   
   
  {{APIComment|'Apply the update to the URD. Changes will be reflected in the repository.}}
  {{APIComment|'Apply the change to the URD. Changes are recorded in the Synthesis repository.}}
   MyRepository.URD.UpdateURD(MyURD)
   MyRepository.URD.UpdateURD(MyURD)

Revision as of 20:52, 24 August 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Applies any changes made to an existing URD. Returns a Boolean value; when true, indicates a successful save.

Syntax

.URD.UpdateURD(urd)

Parameters

urd

Required. The cURD object to be updated.


Example

This example assumes that a URD with ID #1 exists in the first available project in a repository.

VBA

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

 
 'Get URD #1 from project #1. 
 Dim MyURD As cURD
 MyRepository.Project.SetCurrentProject(1)  
 Set MyURD = MyRepository.URD.GetURD(1)

 'Change the URD's name to "New_Name." 
 MyURD.Name = "New_Name"

 'Apply the change to the URD. Changes are recorded in the Synthesis repository. 
 Call MyRepository.URD.UpdateURD(MyURD)
VB.NET

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

 
 'Get URD #1 from project #1. 
 Dim MyURD As cURD
 MyRepository.Project.SetCurrentProject(1)  
 MyURD = MyRepository.URD.GetURD(1)

 'Change the URD's name to "New_Name." 
 MyURD.Name = "New_Name"

 'Apply the change to the URD. Changes are recorded in the Synthesis repository. 
 MyRepository.URD.UpdateURD(MyURD)