Difference between revisions of "Repository.XFRACAS.GetAllXFRACASEntities"

From ReliaWiki
Jump to navigation Jump to search
 
(3 intermediate revisions by one other user not shown)
Line 2: Line 2:
  
  
<onlyinclude>Gets a list of XFRACAS entities associated with a [[Repository_Class|Repository]] object. Returns a '''[[NameIdPair Class|NameIDPair]]''' object that represents the name and ID pair of the XFRACAS entities.</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 16: Line 16:
 
    
 
    
 
  {{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)