Repository.URD.UpdateURD: Difference between revisions

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


Saves all updates to a URD. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.   
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.   
<noinclude>
<noinclude>
== Syntax ==
== Syntax ==
''object''.'''URD.UpdateURD(''urd'')'''
'''.URD.UpdateURD'''(''urd'')
 
where ''object'' is a variable that represents a Repository object.
 
=== Parameters ===
=== Parameters ===
{| {{APITable}}
''urd''
|-
:The [[CURD Class|cURD]] object to be updated.
|urd{{APIParam|Required}}||The [[CURD Class|cURD]] object to be updated.
|}




Line 20: Line 15:
  '''VBA'''
  '''VBA'''
   
   
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|'Add code to connect to a Synthesis repository.}}
{{APIComment|...'Add code to connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
    
    
  {{APIComment|'Get URD #1 from project #1.}}
  {{APIComment|'Get URD #1 from project #1.}}
Line 36: Line 33:
  '''VB.NET'''
  '''VB.NET'''
   
   
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|'Add code to connect to a Synthesis repository.}}
{{APIComment|...'Add code to connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
    
    
  {{APIComment|'Get URD #1 from project #1.}}
  {{APIComment|'Get URD #1 from project #1.}}

Revision as of 20:23, 20 July 2015

APIWiki.png


Member of: SynthesisAPI10.Repository

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.

Syntax

.URD.UpdateURD(urd)

Parameters

urd

The cURD object to be updated.


Example

This example assumes that a URD with ID#1 exists in the 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 update to the URD. Changes will be reflected in the 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 update to the URD. Changes will be reflected in the repository. 
 MyRepository.URD.UpdateURD(MyURD)