Repository.Crew.UpdateCrew: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(16 intermediate revisions by 5 users not shown)
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
Updates the Crew
== Method Syntax==
{{APIName|'''UpdateCrew'''(}}
{{APIPrefix|ByVal}}
{{APIName|crew}}
{{APIPrefix|As}}
{{APIName|[[cCrew Class|cCrew]])}}
{{APIPrefix|As Boolean}}<br>
{{APIComment|Updates the Crew in the repository.}}


== Parameters ==
'''crew'''
{{APIComment|The crew to update in the repository.}}


== Usage Example ==
<onlyinclude>Updates the properties of a given crew resource in the current project. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude> 
{{APIComment|Declare a new repository connection class.}}
        Private WithEvents MyRepository As New Repository


{{APIComment|Connect to the Synthesis repository.}}
== Syntax ==
        Dim Success As Boolean = False
'''.Crew.UpdateCrew'''(''crew'')
        Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")


{{APIComment|Get the list of Projects in the connected repository.}}
=== Parameters ===
        Dim ListOfCrews() As [[cCrew Class|cCrew]]
''crew''
        ListOfCrews = MyRepository.GetAllCrews()
:Required. The [[CCrew Class|cCrew]] object that represents the crew resource to be updated.


{{APIComment|After modifying the Crew, Update the repository.}}
 
        Dim SuccessUpdateCrew As Boolean = False
== Example ==
        SuccessUpdateCrew = MyRepository.UpdateCrew(ListOfCrews(0))
This example assumes that a crew with ID #1 exists in the first available project of a repository.
 
'''VBA'''
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
{{APIComment|'Get crew #1 from project #1.}}
  {{APIPrefix|Dim}} MyCrew {{APIPrefix|As}} cCrew
  MyRepository.Project.SetCurrentProject(1) 
  {{APIPrefix|Set}} MyCrew = MyRepository.Crew.GetCrew(1)
{{APIComment|'Change the crew's name to "New_Name."}}
  MyCrew.Name = {{APIString|"New_Name"}}
{{APIComment|'Send the change to the Synthesis repository.}}
  {{APIPrefix|Call}} MyRepository.Crew.UpdateCrew(MyCrew)
 
'''VB.NET'''
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
{{APIComment|'Get crew #1 from project #1.}}
  {{APIPrefix|Dim}} MyCrew {{APIPrefix|As}} cCrew
  MyRepository.Project.SetCurrentProject(1) 
  MyCrew = MyRepository.Crew.GetCrew(1)
{{APIComment|'Change the crew's name to "New_Name."}}
  MyCrew.Name = {{APIString|"New_Name"}}
{{APIComment|'Send the change to the Synthesis repository.}}
  MyRepository.Crew.UpdateCrew(MyCrew)

Latest revision as of 17:01, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Updates the properties of a given crew resource in the current project. Returns a Boolean value; when true, indicates a successful save.

Syntax

.Crew.UpdateCrew(crew)

Parameters

crew

Required. The cCrew object that represents the crew resource to be updated.


Example

This example assumes that a crew with ID #1 exists in the first available project of a repository. 

VBA

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
  
 'Get crew #1 from project #1. 
  Dim MyCrew As cCrew
  MyRepository.Project.SetCurrentProject(1)  
  Set MyCrew = MyRepository.Crew.GetCrew(1)

 'Change the crew's name to "New_Name." 
  MyCrew.Name = "New_Name"

 'Send the change to the Synthesis repository. 
  Call MyRepository.Crew.UpdateCrew(MyCrew)

VB.NET

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
  
 'Get crew #1 from project #1. 
  Dim MyCrew As cCrew
  MyRepository.Project.SetCurrentProject(1)  
  MyCrew = MyRepository.Crew.GetCrew(1)

 'Change the crew's name to "New_Name." 
  MyCrew.Name = "New_Name"

 'Send the change to the Synthesis repository. 
  MyRepository.Crew.UpdateCrew(MyCrew)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Crew.UpdateCrew&oldid=64256"