Repository.Action.GetAllActionsDictionary: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(15 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
{{Template:Repository.GetAllActions.Cmt}}


== Syntax==
*GetAllActionsDictionary() {{APIPrefix|As}} Dictionary(Of Integer, [[cAction Class|cAction]])


== Usage Example ==
<onlyinclude>Returns a dictionary object that contains all available action resources in the current project. The dictionary syntax is '''Dictionary(Of Integer, cAction)''', where the ID numbers are the keys and the [[CAction Class|cAction]] objects that represent the action resources are the associated values. (.NET only)</onlyinclude>
<div style="margin-right: 150px;">
 
{{APIComment|'Declare a new repository connection object.}}
== Syntax ==
  Dim MyRepository As New Repository
  '''.Action.GetAllActionsDictionary()'''
 
 
  {{APIComment|'Connect to the Synthesis repository.}}
  Dim Success As Boolean = False
  Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")


{{APIComment|'Set a first available project as current.}}
== Example ==
  MyRepository.Project.SetCurrentProject(0)
This example assumes that actions exist in the first available project of the repository.
'''VB.NET'''
    
    
  {{APIComment|'Get the dictionary of actions in the connected repository.}}
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  Dim actions As Dictionary(Of Integer, cAction)
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  actions = MyRepository.Action.GetAllActionsDictionary()
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
</div>
{{APIComment|'Set the first project in the repository as the current project.}}
  MyRepository.Project.SetCurrentProject(1) 
   
{{APIComment|'Declare a new dictionary object.}}
  {{APIPrefix|Dim}} ActionsDict {{APIPrefix|As}} Dictionary (of Integer, cAction)
{{APIComment|'Add values to the dictionary.}}
  ActionsDict = MyRepository.Action.GetAllActionsDictionary()
{{APIComment|'Output sample: Display the number of entries in the dictionary.}}
  MsgBox(ActionsDict.Count)

Latest revision as of 15:08, 3 August 2017

APIWiki.png


Member of: SynthesisAPI.Repository


Returns a dictionary object that contains all available action resources in the current project. The dictionary syntax is Dictionary(Of Integer, cAction), where the ID numbers are the keys and the cAction objects that represent the action resources are the associated values. (.NET only)

Syntax

.Action.GetAllActionsDictionary()


Example

This example assumes that actions exist in the first available project of the repository. 

VB.NET 
 
 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")

 'Set the first project in the repository as the current project. 
  MyRepository.Project.SetCurrentProject(1)  
   
 'Declare a new dictionary object. 
  Dim ActionsDict As Dictionary (of Integer, cAction)  

 'Add values to the dictionary. 
  ActionsDict = MyRepository.Action.GetAllActionsDictionary()

 'Output sample: Display the number of entries in the dictionary. 
  MsgBox(ActionsDict.Count)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Action.GetAllActionsDictionary&oldid=65105"