Repository.URD.GetAllURDs: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
m (Protected "Repository.GetAllURDs" ([edit=sysop] (indefinite) [move=sysop] (indefinite)) [cascading])
No edit summary
 
(20 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
Gets an array containing all URDs
== Method Syntax==
{{APIName|'''GetAllURDs'''()}}
{{APIPrefix|As}}
{{APIName|[[cURD Class|cURD]]()}}<br>
{{APIComment|Returns an array containing all URDs from the current project.}}


== Usage Example ==
{{APIComment|Declare a new repository connection class.}}
        Private WithEvents MyRepository As New Repository


{{APIComment|Connect to the Synthesis repository.}}
<onlyinclude>Returns an array of '''[[CURD Class|cURD]]''' objects that represent the universal reliability definitions (URDs) in the current project.</onlyinclude>
        Dim Success As Boolean = False
        Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")


{{APIComment|Get list of URDs.}}
== Syntax ==
        Dim ListOfURDs() as [[cURD Class|cURD]]
'''.URD.GetAllURDs'''(''Filter'')
        ListOfURDs = MyRepository.GetAllURDs()
 
===Parameters===
''Filter''
:Optional. A filter that returns a particular type of resource (e.g., global only, local and global only, etc.). Can be any [[ResourceFilterEnum Enumeration|ResourceFilterEnum]] constant. Default value = 0, which returns local resources only.
 
 
== Example ==
This example assumes that URDs exist in the first available project of a repository.
 
'''VBA|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 a list of all local URDs in project #1.}}
  {{APIPrefix|Dim}} ListofURDs() {{APIPrefix|As}} cURD
  MyRepository.Project.SetCurrentProject (1) 
  ListofURDs = MyRepository.URD.GetAllURDs()
{{APIComment|'Output sample: Display the number of URDs in the project.}}
  {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  NumberofElements = UBound(ListofURDs) - LBound(ListofURDs) + 1
  MsgBox (NumberofElements)

Latest revision as of 18:55, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Returns an array of cURD objects that represent the universal reliability definitions (URDs) in the current project.

Syntax

.URD.GetAllURDs(Filter)

Parameters

Filter

Optional. A filter that returns a particular type of resource (e.g., global only, local and global only, etc.). Can be any ResourceFilterEnum constant. Default value = 0, which returns local resources only.


Example

This example assumes that URDs exist in the first available project of a repository. 

VBA|VB.NET
 
 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
 
 'Get a list of all local URDs in project #1. 
  Dim ListofURDs() As cURD
  MyRepository.Project.SetCurrentProject (1)  
  ListofURDs = MyRepository.URD.GetAllURDs()

 'Output sample: Display the number of URDs in the project. 
  Dim NumberofElements As Integer
  NumberofElements = UBound(ListofURDs) - LBound(ListofURDs) + 1
  MsgBox (NumberofElements)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.URD.GetAllURDs&oldid=64328"