Repository.XFRACAS.GetAllXFRACASEntities: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(7 intermediate revisions by one other user not shown)
Line 1: Line 1:
{{DISPLAYTITLE:Repository.XFRACAS.GetAllXfracasEntities Method}}{{Template:API}}{{Template:APIBreadcrumb|9|.[[Repository Class|Repository]]}}
{{DISPLAYTITLE:Repository.XFRACAS.GetAllXfracasEntities Method}}{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}




<onlyinclude>Gets a list of XFRACAS entities connected to the Synthesis enterprise repository. Returns a '''[[NameIdPair Class|NameIDPair]]''' object array that contains all the entities connected to that repository.</onlyinclude>
<onlyinclude>Returns an array of '''[[NameIdPair Class|NameIDPair]]''' objects (effectively Dictionaries) that represent the name and ID pairs of the XFRACAS entities in the database.</onlyinclude>


== Syntax ==
== Syntax ==
Line 9: Line 9:


== Example ==
== Example ==
  '''VBA|VB.NET'''
  '''VB.NET'''
   
   
  {{APIComment|'Add code to connect to the Synthesis enterprise repository.}}
  {{APIComment|'Connect to a Synthesis enterprise repository.}}
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
  MyRepository.ConnectToSQLRepository({{APIString|"MyServer"}}, {{APIString|"MyDatabase"}})
    
    
  {{APIComment|'Get a list of all XFRACAS entities.}}  
  {{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()
   
   
  {{APIComment|'Output sample: Display the number of elements in the array.}}
  {{APIComment|'Output sample: Display the number of elements in the array.}}
  {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
  NumberofElements = UBound(ListofEntities) - LBound(ListofEntities) + 1
  NumberofElements = UBound(ListofEntities) - LBound(ListofEntities) + 1
  MsgBox (NumberofElements)
  MsgBox (NumberofElements)

Latest revision as of 17:52, 30 November 2017

APIWiki.png


Member of: SynthesisAPI.Repository


Returns an array of NameIDPair objects (effectively Dictionaries) that represent the name and ID pairs of the XFRACAS entities in the database.

Syntax

.XFRACAS.GetAllXfracasEntities()


Example

VB.NET

 'Connect to a Synthesis enterprise repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToSQLRepository("MyServer", "MyDatabase")
 
 'Get a list of all XFRACAS entities.  
  Dim ListofEntities() As NameIDPair
  ListOfEntities = MyRepository.XFRACAS.GetAllXfracasEntities()

 'Output sample: Display the number of elements in the array. 
  Dim NumberofElements As Integer
  NumberofElements = UBound(ListofEntities) - LBound(ListofEntities) + 1
  MsgBox (NumberofElements)