Repository.XFRACAS.GetAllXFRACASEntities: Difference between revisions

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




<onlyinclude>Gets a list of all XFRACAS entity names connected to the current repository. Returns a '''[[NameIdPair Class|NameIDPair]]''' object array that contains the entity names and ID numbers.</onlyinclude>
<onlyinclude>Gets a list of all XFRACAS entities connected to the current repository. Returns a '''[[NameIdPair Class|NameIDPair]]''' object array that contains the entity names and ID numbers.</onlyinclude>


== Syntax ==
== Syntax ==
Line 16: Line 16:
   
   
    
    
  {{APIComment|'Get a list of all XFRACAS entities in the repository.}}  
  {{APIComment|'Get a list of all XFRACAS entities.}}  
   {{APIPrefix|Dim}} ListofEntities() {{APIPrefix|As}} NameIDPair
   {{APIPrefix|Dim}} ListofEntities() {{APIPrefix|As}} NameIDPair
   ListOfEntities = MyRepository.XFRACAS.GetAllXfracasEntities()
   ListOfEntities = MyRepository.XFRACAS.GetAllXfracasEntities()

Revision as of 16:56, 18 August 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Gets a list of all XFRACAS entities connected to the current repository. Returns a NameIDPair object array that contains the entity names and ID numbers.

Syntax

.XFRACAS.GetAllXfracasEntities()


Example

VBA|VB.NET

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ... 

 
 'Get a list of all XFRACAS entities.  
 Dim ListofEntities() As NameIDPair
 ListOfEntities = MyRepository.XFRACAS.GetAllXfracasEntities()

 'Output sample: Display the name and ID of the first available entity. 
 Dim EntityName As String
 Dim EntityID As Integer
 EntityName = ListofEntities(0).Name
 EntityID = ListofEntities(0).ID
 MsgBox (EntityName & ", " & EntityID)