Repository.BlockSim.UpdateRBDBlockData: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
Line 1: Line 1:
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
{{Template:InProgress}}
 
 
<onlyinclude>Sends any changes made to a BlockSim block to the Synthesis repository. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>
 
==Syntax==
'''.BlockSim.UpdateRBDBlockData'''(''data'')
 
===Parameters===
''data''
:Required. The [[RBDBlockData Class|RBDBlockData]] object to be updated.
 
 
==Example==
'''VBA'''
 
{{APIComment|'Connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
{{APIComment|'Connect to project #1 in the repository.}}
  MyRepository.Project.SetCurrentProject (1)
   
{{APIComment|'Get the data for all blocks in diagram #21.}}
  {{APIPrefix|Dim}} BlockData() {{APIPrefix|As}} RBDBlockData
  BlockData = MyRepository.BlockSim.GetAllRBDBlocksData(21)
{{APIComment|'Change the block name and associated URD of the first block in the array.}}
  BlockData(0).DisplayName = {{APIString|"New Block Name"}}
  BlockData(0).URDID = 2
{{APIComment|'Send the changes to the Synthesis repository.}}
  {{APIPrefix|Call}} MyRepository.BlockSim.UpdateRBDBlockData(BlockData(0))
 
'''VB.NET'''
 
{{APIComment|'Connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
{{APIComment|'Connect to project #1 in the repository.}}
  MyRepository.Project.SetCurrentProject (1)
   
{{APIComment|'Get the data for all blocks in diagram #21.}}
  {{APIPrefix|Dim}} BlockData() {{APIPrefix|As}} RBDBlockData
  BlockData = MyRepository.BlockSim.GetAllRBDBlocksData(21)
{{APIComment|'Change the block name and associated URD of the first block in the array.}}
  BlockData(0).DisplayName = {{APIString|"New Block Name"}}
  BlockData(0).URDID = 2
 
{{APIComment|'Send the changes to the Synthesis repository.}}  
  MyRepository.BlockSim.UpdateRBDBlockData(BlockData(0))

Latest revision as of 23:32, 6 September 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Sends any changes made to a BlockSim block to the Synthesis repository. Returns a Boolean value; when true, indicates a successful save.

Syntax

.BlockSim.UpdateRBDBlockData(data)

Parameters

data

Required. The RBDBlockData object to be updated.


Example

VBA
 
 'Connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")

 'Connect to project #1 in the repository. 
  MyRepository.Project.SetCurrentProject (1)
   
 'Get the data for all blocks in diagram #21. 
  Dim BlockData() As RBDBlockData
  BlockData = MyRepository.BlockSim.GetAllRBDBlocksData(21)

 'Change the block name and associated URD of the first block in the array.  
  BlockData(0).DisplayName = "New Block Name"
  BlockData(0).URDID = 2

 'Send the changes to the Synthesis repository.  
  Call MyRepository.BlockSim.UpdateRBDBlockData(BlockData(0))
VB.NET
 
 'Connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")

 'Connect to project #1 in the repository. 
  MyRepository.Project.SetCurrentProject (1)
   
 'Get the data for all blocks in diagram #21. 
  Dim BlockData() As RBDBlockData
  BlockData = MyRepository.BlockSim.GetAllRBDBlocksData(21)

 'Change the block name and associated URD of the first block in the array. 
  BlockData(0).DisplayName = "New Block Name"
  BlockData(0).URDID = 2
  
 'Send the changes to the Synthesis repository.  
  MyRepository.BlockSim.UpdateRBDBlockData(BlockData(0))