Repository.XFRACAS.GetAllXFRACASEntities: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:APIClass|Repository Class|Repository}}


== Declaration  ==
== Method Syntax ==
 
{{APIPrefix|Public Function}}
{{APIName|GetAllXFRACASEntities()}}
{{APIName|GetAllXFRACASEntities()}}
{{APIPrefix|As}}
{{APIPrefix|As}}
{{APIName|NameIdPair()}}
{{APIName|[[NameIdPair Class|NameIdPair]]()}}


{{APIComment|Returns an array containing all entity names and and their IDs from the current repository.}}


{{APIComment|Returns an array containing all entity names and and their IDs from the current repository.}}
== Usage Example ==
{{APIComment|Declare a new repository connection class.}}
        Private WithEvents MyRepository As New Repository
 
{{APIComment|Connect to the Synthesis repository.}}
        Dim Success As Boolean = False
        Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
 
{{APIComment|Get the list of XFRACAS Entities in the current project in the connected repository.}}
        Dim ListOfXFRACASEntities() As [[NameIdPair Class|NameIdPair]]
        ListOfXFRACASEntities = MyRepository.GetAllXFRACASEntities()

Revision as of 22:08, 19 September 2013



Method Syntax

GetAllXFRACASEntities() As NameIdPair()

Returns an array containing all entity names and and their IDs from the current repository.

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()