Difference between revisions of "Repository.Profile.GetAllProfiles"

From ReliaWiki
Jump to navigation Jump to search
(Created page with '{{Template:API}}{{Template:APIBreadcrumb|.Repository}}{{InProgress}} <onlyinclude>Returns an array of '''cProfile''' objects that repres…')
 
Line 22: Line 22:
 
    
 
    
 
  {{APIComment|'Get a list of all profiles in project #1.}}
 
  {{APIComment|'Get a list of all profiles in project #1.}}
   {{APIPrefix|Dim}} ListofProfiles() {{APIPrefix|As}} cProfile
+
   {{APIPrefix|Dim}} ListofProfiles() {{APIPrefix|As}} SynthesisAPI.cProfile
 
   MyRepository.Project.SetCurrentProject (1)   
 
   MyRepository.Project.SetCurrentProject (1)   
 
   ListofProfiles = MyRepository.Profile.GetAllProfiles()
 
   ListofProfiles = MyRepository.Profile.GetAllProfiles()
 
   
 
   
  {{APIComment|'Output sample: Display the number of actions in the project.}}
+
  {{APIComment|'Output sample: Display the number of profiles in the project.}}
 
   {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
 
   {{APIPrefix|Dim}} NumberofElements {{APIPrefix|As}} Integer
 
   NumberofElements = UBound(ListofProfiles) - LBound(ListofProfiles) + 1
 
   NumberofElements = UBound(ListofProfiles) - LBound(ListofProfiles) + 1
 
   MsgBox (NumberofElements)
 
   MsgBox (NumberofElements)

Revision as of 17:27, 4 October 2016

APIWiki.png


Member of: SynthesisAPI.Repository

DRAFT GRAY.png

WORK IN PROGRESS
Repository.Profile.GetAllProfiles

DRAFT GRAY.png


Returns an array of cProfile objects that represent the profile resources in the current project.

Syntax

.Profile.GetAllProfiles(Filter)

Parameters

Filter

Optional. A filter that returns a particular type of resource (e.g., global only, local and global only, etc.). Can be any ResourceFilterEnum constant. Default value = 0, which returns local resources only.


Example

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

VBA|VB.NET
 
 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr11")
  
 'Get a list of all profiles in project #1. 
  Dim ListofProfiles() As SynthesisAPI.cProfile
  MyRepository.Project.SetCurrentProject (1)  
  ListofProfiles = MyRepository.Profile.GetAllProfiles()

 'Output sample: Display the number of profiles in the project. 
  Dim NumberofElements As Integer
  NumberofElements = UBound(ListofProfiles) - LBound(ListofProfiles) + 1
  MsgBox (NumberofElements)