Repository.URD.UpdateURD: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:APIBreadcrumb|10|Repository}}
{{Template:Repository.UpdateURD.Cmt}} {{Template:BooleanReturn.Cmt}}
{{Template:API}}
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.


== Syntax==
== Syntax ==
*UpdateURD( urd {{APIPrefix|As}} [[cURD Class|cURD]] ) {{APIPrefix|As Boolean}}
''object''.'''URD.UpdateURD(''urd'')'''


Parameters:
where ''object'' is a variable that represents a Repository object.
:''urd'': The [[cURD Class|cURD]] to update.


== Usage Example ==
=== Parameters ===
{{APIComment|'Declare a new repository connection object.}}
{| {{APITable}}
   Dim MyRepository As New Repository
|-
|urd{{APIParam|Required}]||The '''[[CURD Class|cURD]]''' object to be updated.
|}
 
 
== Example ==
This example assumes that a URD with ID#1 exists in the repository.
 
'''VBA'''
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|...'Add code to connect to a Synthesis repository.}}
    
    
  {{APIComment|'Connect to the Synthesis repository.}}
  {{APIComment|'Get URD #1 from project #1.}}
   Dim Success As Boolean = False
   {{APIPrefix|Dim}} MyURD {{APIPrefix|As}} cURD
   Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
  MyRepository.Project.SetCurrentProject(1) 
   {{APIPrefix|Set}} MyURD = MyRepository.URD.GetURD(1)
{{APIComment|'Change the URD's name to "New_Name".}}
  MyURD.Name = "New_Name"
{{APIComment|'Apply the update to the URD. Changes will be reflected in the repository.}}
  {{APIPrefix|Call}} MyRepository.URD.UpdateURD(MyURD)
 
'''VB.NET'''
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|...'Add code to connect to a Synthesis repository.}}
    
    
  {{APIComment|'Set a first available project as current.}}
  {{APIComment|'Get URD #1 from project #1.}}
   MyRepository.Project.SetCurrentProject(0)
  {{APIPrefix|Dim}} MyURD {{APIPrefix|As}} cURD
   MyRepository.Project.SetCurrentProject(1) 
  MyURD = MyRepository.URD.GetURD(1)
   
   
  {{APIComment|'Get a list of URDs.}}
  {{APIComment|'Change the URD's name to "New_Name".}}
   Dim ListOfURDs() as cURD
   MyURD.Name = "New_Name"
  ListOfURDs = MyRepository.URD.GetAllURDs()
 
  {{APIComment|'Apply the update to the URD. Changes will be reflected in the repository.}}
  {{APIComment|'After modifying the URD, update the repository.}}
   MyRepository.URD.UpdateURD(MyURD)
   Dim SuccessUpdateURD As Boolean = False
  SuccessUpdateURD = MyRepository.URD.UpdateURD(ListOfURDs(0))

Revision as of 22:57, 14 July 2015

Member of: SynthesisAPI10Repository

APIWiki.png


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.

Syntax

object.URD.UpdateURD(urd)

where object is a variable that represents a Repository object.

Parameters

Name Description
Required}] The cURD object to be updated.


Example

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

VBA

 Dim MyRepository As New Repository
 ...'Add code to connect to a Synthesis 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

 Dim MyRepository As New Repository
 ...'Add code to connect to a Synthesis 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)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.URD.UpdateURD&oldid=59404"