Repository.XFRACAS.GetAllXFRACASEntities: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 8: Line 8:


== Usage Example ==
== Usage Example ==
{{APIComment|Code Block}}
  '{{APIComment|Declare a new repository connection class.}}
  '{{APIComment|Declare a new repository connection class.}}
  {{APIPrefix|Private WithEvents MyRepository As [[New Repository]]}}
  {{APIPrefix|Private WithEvents MyRepository As [[New Repository]]}}

Revision as of 20:24, 18 October 2013


Returns an array containing all entity names and and their IDs

Method Syntax

Public Function GetAllXFRACASEntities() As NameIdPair()
Returns an array containing all entity names and and their IDs from the current repository.

Usage Example

Code Block

' Declare a new repository connection class. 
Private WithEvents MyRepository As New Repository
' Connect to the Synthesis repository. 
DimSuccessAs Boolean=False
Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
' Get the list of XFRACAS Entities in the current project in the connected repository. 
DimListOfXFRACASEntities() As NameIdPair
ListOfXFRACASEntities = MyRepository.GetAllXFRACASEntities()


Reformatted Usage Example

Declare a new repository connection class.

       Private WithEvents MyRepository As New Repository

Connect to the Synthesis repository.

       Dim Success As Boolean = False
       Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")

Get the list of XFRACAS Entities in the current project in the connected repository.

       Dim ListOfXFRACASEntities() As NameIdPair
       ListOfXFRACASEntities = MyRepository.GetAllXFRACASEntities()