Repository.XFRACAS.GetAllXFRACASEntities: Difference between revisions
Jump to navigation
Jump to search
John Leavitt (talk | contribs) No edit summary |
John Leavitt (talk | contribs) No edit summary |
||
| Line 8: | Line 8: | ||
== Usage Example == | == Usage Example == | ||
'{{APIComment|Declare a new repository connection class.}} | |||
{{APIPrefix|Private WithEvents MyRepository As [[New Repository]]}} | |||
'{{APIComment|Connect to the Synthesis repository.}} | |||
{{APIPrefix|Dim}}Success{{APIPrefix|As Boolean}}={{APIPrefix|False}} | |||
Success = MyRepository.[[Repository.ConnectToRepository|ConnectToRepository]]("RepositoryFileNamePath") | |||
'{{APIComment|Get the list of XFRACAS Entities in the current project in the connected repository.}} | |||
{{APIPrefix|Dim}}ListOfXFRACASEntities() {{APIPrefix|As}} [[NameIdPair Class|NameIdPair]] | |||
ListOfXFRACASEntities = MyRepository.[[Repository.GetAllXFRACASEntities|GetAllXFRACASEntities]]() | |||
== Reformatted Usage Example == | |||
{{APIComment|Declare a new repository connection class.}} | {{APIComment|Declare a new repository connection class.}} | ||
Private WithEvents MyRepository As New Repository | Private WithEvents MyRepository As [[New Repository]] | ||
{{APIComment|Connect to the Synthesis repository.}} | {{APIComment|Connect to the Synthesis repository.}} | ||
Dim Success As Boolean = False | Dim Success As Boolean = False | ||
Success = MyRepository.ConnectToRepository("RepositoryFileNamePath") | Success = MyRepository.[[Repository.ConnectToRepository|ConnectToRepository]]("RepositoryFileNamePath") | ||
{{APIComment|Get the list of XFRACAS Entities in the current project in the connected repository.}} | {{APIComment|Get the list of XFRACAS Entities in the current project in the connected repository.}} | ||
Dim ListOfXFRACASEntities() As [[NameIdPair Class|NameIdPair]] | Dim ListOfXFRACASEntities() As [[NameIdPair Class|NameIdPair]] | ||
ListOfXFRACASEntities = MyRepository.GetAllXFRACASEntities() | ListOfXFRACASEntities = MyRepository.[[Repository.GetAllXFRACASEntities|GetAllXFRACASEntities]]() | ||
Revision as of 17:26, 18 October 2013
Returns an array containing all entity names and and their IDs
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. 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()