Repository.URD.UpdateURD: Difference between revisions

Latest revision as of 17:45, 9 June 2016

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)

@@ Line 1: / Line 1: @@
-{{Template:APIClass|Repository Class|Repository}}
+{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
-Updates the URD
-== Method Syntax==
-{{APIName|'''UpdateURD'''(}}
-{{APIPrefix|ByVal}}
-{{APIName|urd}}
-{{APIPrefix|As}}
-{{APIName|[[cURD Class|cURD]]}}
-{{APIName|)}}
-{{APIPrefix|As Boolean}}<br>
-{{APIComment|Updates the URD in the repository.}}
-== Usage Example ==
-{{APIComment|Declare a new repository connection class.}}
-        Private WithEvents MyRepository As New Repository
-{{APIComment|Connect to the Synthesis repository.}}
+<onlyinclude>Updates the properties of a given URD resource in the current project. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude>
-        Dim Success As Boolean = False
-        Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
-{{APIComment|Get list of URDs.}}
+== Syntax ==
-        Dim ListOfURDs() as [[cURD Class|cURD]]
+ '''.URD.UpdateURD'''(''urd'')
-        ListOfURDs = MyRepository.GetAllURDs()
+=== Parameters ===
+''urd''
+:Required. The [[CURD Class|cURD]] object that represents the URD resource to be updated.
-{{APIComment|After modifying the URD, update the repository.}}
-        Dim SuccessUpdateURD As Boolean = False
+== Example ==
-        SuccessUpdateURD = MyRepository.UpdateURD(ListOfURDs(0))
+This example assumes that a URD with ID #1 exists in the first available project of a repository.
+ '''VBA'''
+ {{APIComment|'Declare a new Repository object and 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.}}
+   {{APIPrefix|Dim}} MyURD {{APIPrefix|As}} cURD
+   MyRepository.Project.SetCurrentProject(1)
+   {{APIPrefix|Set}} MyURD = MyRepository.URD.GetURD(1)
+ {{APIComment|'Change the URD's name to "New_Name."}}
+   MyURD.Name = {{APIString|"New_Name"}}
+ {{APIComment|'Send the change to the Synthesis repository.}}
+   {{APIPrefix|Call}} MyRepository.URD.UpdateURD(MyURD)
+ '''VB.NET'''
+ {{APIComment|'Declare a new Repository object and 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.}}
+   {{APIPrefix|Dim}} MyURD {{APIPrefix|As}} cURD
+   MyRepository.Project.SetCurrentProject(1)
+   MyURD = MyRepository.URD.GetURD(1)
+ {{APIComment|'Change the URD's name to "New_Name."}}
+   MyURD.Name = {{APIString|"New_Name"}}
+ {{APIComment|'Send the change to the Synthesis repository.}}
+   MyRepository.URD.UpdateURD(MyURD)

Repository.URD.UpdateURD: Difference between revisions

Latest revision as of 17:45, 9 June 2016

Syntax

Parameters

Example

Navigation menu

Search