Repository.Model.UpdateModel: Difference between revisions

Latest revision as of 20:34, 18 August 2016

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

Remarks: This method does not apply to published models, which are model resources that have been published from and are associated with an existing analysis/data source.

Syntax

.Model.UpdateModel(m)

Parameters

m

Required. The cModel object that represents the model resource to be updated.

Example

This example assumes that a model with ID #47 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 model #47 from project #1. 
  Dim AModel As cModel
  MyRepository.Project.SetCurrentProject(1)  
  Set AModel = MyRepository.Model.GetModel(47)

 'Change the model's name to "New_Name." 
  AModel.Name = "New_Name"

 'Send the change to the Synthesis repository. 
  Call MyRepository.Model.UpdateModel(AModel)

VB.NET

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

  'Get model #47 from project #1. 
  Dim AModel As cModel
  MyRepository.Project.SetCurrentProject(1)  
  AModel = MyRepository.Model.GetModel(47)

 'Change the model's name to "New_Name." 
  AModel.Name = "New_Name"

 'Send the change to the Synthesis repository. 
  MyRepository.Model.UpdateModel(AModel)

@@ Line 1: / Line 1: @@
-{{Template:APIBreadcrumb|10|Repository}}
+{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
-{{Template:API}}
-Saves all updates to a model that you specify. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.
+<onlyinclude>Updates the properties of a given model resource in the current project. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude>
-== Syntax ==
-''object''.'''Model.UpdateModel(''m'')'''
-where ''object'' is a variable that represents a Repository object.
+'''Remarks''': This method does not apply to published models, which are model resources that have been published from and are associated with an existing analysis/data source.
+== Syntax ==
+ '''.Model.UpdateModel'''(''m'')
 === Parameters ===
-{| {{APITable}}
+''m''
-|-
+:Required. The [[CModel Class|cModel]] object that represents the model resource to be updated.
-|m{{APIParam|Required}}||The '''[[CModel Class|cModel]]''' object to be updated.
-|}
 == Example ==
-  '''VBA'''<br>
+This example assumes that a model with ID #47 exists in the first available project of a repository.
-  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
-  {{APIComment|...'Add code to connect to a Synthesis repository.}}<br>
+  '''VBA'''
-  {{APIComment|'Get the model. If getting a local model, add code to specify the current project.}}
-  {{APIComment|'For example, the following code retrieves model #47 from project #1.}}
+ {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
-  {{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel
+   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
-  MyRepository.Project.SetCurrentProject(1)
+   MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
-  AModel = MyRepository.Model.GetModel(47)<br>
-  {{APIComment|'Change model #47's name to "New Name".}}
+  {{APIComment|'Get model #47 from project #1.}}
-  {{APIPrefix|Set}} AModel.Name = "New Name"<br>
+   {{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel
-  {{APIComment|'Apply the update to the model. Changes will be reflected in the repository.}}
+   MyRepository.Project.SetCurrentProject(1)
-  MyRepository.Model.UpdateModel(AModel)
+   {{APIPrefix|Set}} AModel = MyRepository.Model.GetModel(47)
+ {{APIComment|'Change the model's name to "New_Name."}}
+   AModel.Name = {{APIString|"New_Name"}}
+ {{APIComment|'Send the change to the Synthesis repository.}}
+   {{APIPrefix|Call}} MyRepository.Model.UpdateModel(AModel)
+ '''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 model #47 from project #1.}}
+   {{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel
+   MyRepository.Project.SetCurrentProject(1)
+   AModel = MyRepository.Model.GetModel(47)
+  {{APIComment|'Change the model's name to "New_Name."}}
+   AModel.Name = {{APIString|"New_Name"}}
+  {{APIComment|'Send the change to the Synthesis repository.}}
+   MyRepository.Model.UpdateModel(AModel)

Repository.Model.UpdateModel: Difference between revisions

Latest revision as of 20:34, 18 August 2016

Syntax

Parameters

Example

Navigation menu

Search