Repository.URD.AddURD: 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.AddURD.Cmt}} {{Template:BooleanReturn.Cmt}}
{{Template:API}}
Saves a new '''[[CURD Class|cURD]]''' object to the Synthesis repository. Returns a '''Boolean''' value; when true, indicates that the URD now exists in the repository.  


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


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


== 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 added
  {{APIComment|'Connect to the Synthesis repository.}}
|}
   Dim Success As Boolean = False
 
   Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
 
    
== Example ==
  {{APIComment|'Set a first available project as current.}}
'''VBA'''
  MyRepository.Project.SetCurrentProject(0)
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|...'Add code to connect to a Synthesis repository.}}
  {{APIComment|'Create a new URD. The following example creates a URD named "MyNewURD".}}
   {{APIPrefix|Dim}} newURD {{APIPrefix|As New}} cURD
   NewURD.Name = "MyNewURD"
  {{APIComment|'Add the new URD to project #1. The URD will be visible in the Synthesis repository upon refresh.}}
   MyRepository.Project.SetCurrentProject(1) 
   {{APIPrefix|Call}} MyRepository.URD.AddURD(newURD)
 
'''VB.NET'''
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...'Add code to connect to a Synthesis repository.}}
{{APIComment|'Create a new URD. The following example creates a URD named "MyNewURD".}}
  {{APIPrefix|Dim}} newURD {{APIPrefix|As New}} cURD ("MyNewURD")
   
   
  {{APIComment|'Create a new URD.}}
  {{APIComment|'Add the new URD to project #1. The URD will be visible in the Synthesis repository upon refresh.}}
  Dim newURD As New cURD("NewURD1")
   MyRepository.Project.SetCurrentProject(1) 
 
   MyRepository.URD.AddURD(newURD)
{{APIComment|'Add the URD to the repository.}}
   Dim SuccessAddURD As Boolean = False
   SuccessAddURD = MyRepository.URD.AddURD(newURD)

Revision as of 21:44, 14 July 2015

Member of: SynthesisAPI10Repository

APIWiki.png


Saves a new cURD object to the Synthesis repository. Returns a Boolean value; when true, indicates that the URD now exists in the repository.

Syntax

object.URD.AddURD(urd)

where object is a variable that represents a Repository object.

Parameters

Name Description
urdborder="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse; text-align: left; cellborder"
Name Status The cURD object to be added


Example

VBA

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

 'Create a new URD. The following example creates a URD named "MyNewURD". 
 Dim newURD As New cURD
 NewURD.Name = "MyNewURD"

 'Add the new URD to project #1. The URD will be visible in the Synthesis repository upon refresh. 
 MyRepository.Project.SetCurrentProject(1)   
 Call MyRepository.URD.AddURD(newURD)

VB.NET

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

 'Create a new URD. The following example creates a URD named "MyNewURD". 
 Dim newURD As New cURD ("MyNewURD")

 'Add the new URD to project #1. The URD will be visible in the Synthesis repository upon refresh. 
 MyRepository.Project.SetCurrentProject(1)   
 MyRepository.URD.AddURD(newURD)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.URD.AddURD&oldid=59402"