Repository.URD.UpdateURD: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|Repository}}</noinclude>
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}


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. 
<noinclude>
== Syntax ==
''object''.'''URD.UpdateURD(''urd'')'''


where ''object'' is a variable that represents a Repository object.
<onlyinclude>Updates the properties of a given URD resource in the current project. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude> 


== Syntax ==
'''.URD.UpdateURD'''(''urd'')
=== Parameters ===
=== Parameters ===
{| {{APITable}}
''urd''
|-
:Required. The [[CURD Class|cURD]] object that represents the URD resource to be updated.
|urd{{APIParam|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 of a repository.


  '''VBA'''
  '''VBA'''
   
   
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
{{APIComment|...'Add code to connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
 
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
  {{APIComment|'Get URD #1 from project #1.}}
  {{APIComment|'Get URD #1 from project #1.}}
  {{APIPrefix|Dim}} MyURD {{APIPrefix|As}} cURD
  {{APIPrefix|Dim}} MyURD {{APIPrefix|As}} cURD
  MyRepository.Project.SetCurrentProject(1)   
  MyRepository.Project.SetCurrentProject(1)   
  {{APIPrefix|Set}} MyURD = MyRepository.URD.GetURD(1)
  {{APIPrefix|Set}} MyURD = MyRepository.URD.GetURD(1)
   
   
  {{APIComment|'Change the URD's name to "New_Name."}}
  {{APIComment|'Change the URD's name to "New_Name."}}
  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|'Send the change to the Synthesis repository.}}
  {{APIPrefix|Call}} MyRepository.URD.UpdateURD(MyURD)
  {{APIPrefix|Call}} MyRepository.URD.UpdateURD(MyURD)


  '''VB.NET'''
  '''VB.NET'''
   
   
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
{{APIComment|...'Add code to connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
 
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
  {{APIComment|'Get URD #1 from project #1.}}
  {{APIComment|'Get URD #1 from project #1.}}
  {{APIPrefix|Dim}} MyURD {{APIPrefix|As}} cURD
  {{APIPrefix|Dim}} MyURD {{APIPrefix|As}} cURD
  MyRepository.Project.SetCurrentProject(1)   
  MyRepository.Project.SetCurrentProject(1)   
  MyURD = MyRepository.URD.GetURD(1)
  MyURD = MyRepository.URD.GetURD(1)
   
   
  {{APIComment|'Change the URD's name to "New_Name."}}
  {{APIComment|'Change the URD's name to "New_Name."}}
  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|'Send the change to the Synthesis repository.}}
  MyRepository.URD.UpdateURD(MyURD)
  MyRepository.URD.UpdateURD(MyURD)
</noinclude>

Latest revision as of 17:45, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


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

Syntax

.URD.UpdateURD(urd)

Parameters

urd

Required. The cURD object that represents the URD resource to be updated.


Example

This example assumes that a URD 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 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"

 'Send the change to the Synthesis repository. 
  Call MyRepository.URD.UpdateURD(MyURD)

VB.NET

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
  
 '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"

 'Send the change to the Synthesis repository. 
  MyRepository.URD.UpdateURD(MyURD)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.URD.UpdateURD&oldid=64280"