Repository.URD.GetURD: 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.GetURD.Cmt}}
{{Template:API}}
Gets the URD with the designated ID number and returns it as a '''[[CURD Class|cURD]]''' object. Returns nothing if the URD does not exist or is not in the current project.  


== Syntax==
== Syntax ==
*GetURD({{APIPrefix|As}}[[cURD Class|cURD]])
''object''.'''URD.GetURD(''ID'')'''


== Usage Example ==
where ''object'' is a variable that represents a Repository object.
<div style="margin-right: 150px;">
 
{{APIComment|'Declare a new repository connection object.}}
=== Parameters ===
   Dim MyRepository As New Repository
{| {{APITable}}
 
|-
  {{APIComment|'Connect to the Synthesis repository.}}
|ID{{APIParam|Required}}||'''Integer'''. The ID number of the URD to retrieve.
   Dim Success As Boolean = False
|}
   Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
 
    
 
  {{APIComment|'Set a first available project as current.}}
== Example ==
   MyRepository.Project.SetCurrentProject(0)
This example assumes that a URD with ID#1 exists in a repository.
'''VBA'''
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...'Add code to connect to a Synthesis repository.}} 
{{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|'Output sample:}}
   {{APIPrefix|Dim}} URDName {{APIPrefix|As}} String
  {{APIPrefix|Dim}} URDID {{APIPrefix|As}} Integer
  URDName = MyURD.Name
  URDID = MyURD.ID
  MsgBox ({{APIString|"You got "}} & URDName & {{APIString|", ID#"}} & URDID)
 
'''VB.NET'''
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...'Add code to connect to a Synthesis repository.}} 
{{APIComment|'Get URD #1 from project #1.}}
  {{APIPrefix|Dim}} MyURD {{APIPrefix|As}} cURD
   MyRepository.Project.SetCurrentProject(1)
  MyURD = MyRepository.URD.GetURD(1)
   
   
  {{APIComment|'Get URD.}}
  {{APIComment|'Output sample:}}
   Dim GetURD() as cURD
  {{APIPrefix|Dim}} URDName {{APIPrefix|As}} String
   GetURD= MyRepository.URD.GetURD()
   {{APIPrefix|Dim}} URDID {{APIPrefix|As}} Integer
</div>
   URDName = MyURD.Name
  URDID = MyURD.ID
  MsgBox ({{APIString|"You got "}} & URDName & {{APIString|", ID#"}} & URDID)

Revision as of 21:56, 14 July 2015

Member of: SynthesisAPI10Repository

APIWiki.png


Gets the URD with the designated ID number and returns it as a cURD object. Returns nothing if the URD does not exist or is not in the current project.

Syntax

object.URD.GetURD(ID)

where object is a variable that represents a Repository object.

Parameters

Name Description
IDborder="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse; text-align: left; cellborder"
Name Status Integer. The ID number of the URD to retrieve.


Example

This example assumes that a URD with ID#1 exists in a 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)

 'Output sample: 
 Dim URDName As String
 Dim URDID As Integer
 URDName = MyURD.Name
 URDID = MyURD.ID
 MsgBox ("You got " & URDName & ", ID#" & URDID)

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)

 'Output sample: 
 Dim URDName As String
 Dim URDID As Integer
 URDName = MyURD.Name
 URDID = MyURD.ID
 MsgBox ("You got " & URDName & ", ID#" & URDID)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.URD.GetURD&oldid=59403"