Repository.Model.UpdateModel: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
Line 25: | Line 25: | ||
{{APIComment|'Get the model. If getting a local (as opposed to global) model, add code to specify the current project.}} | {{APIComment|'Get the model. If getting a local (as opposed to global) model, add code to specify the current project.}} | ||
{{APIComment|'For example, the following code retrieves model #47 from project #1.}} | {{APIComment|'For example, the following code retrieves model #47 from project #1.}} | ||
{{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel | {{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel | ||
MyRepository.Project.SetCurrentProject(1) | |||
{{APIPrefix|Set}} AModel = MyRepository.Model.GetModel(47)<br> | {{APIPrefix|Set}} AModel = MyRepository.Model.GetModel(47)<br> | ||
{{APIComment|'Change model #47's name to "New_Name".}} | {{APIComment|'Change model #47's name to "New_Name".}} | ||
Line 38: | Line 38: | ||
{{APIComment|'Get the model. If getting a local (as opposed to global) model, add code to specify the current project.}} | {{APIComment|'Get the model. If getting a local (as opposed to global) model, add code to specify the current project.}} | ||
{{APIComment|'For example, the following code retrieves model #47 from project #1.}} | {{APIComment|'For example, the following code retrieves model #47 from project #1.}} | ||
{{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel | |||
{{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel | MyRepository.Project.SetCurrentProject(1) | ||
AModel = MyRepository.Model.GetModel(47)<br> | AModel = MyRepository.Model.GetModel(47)<br> | ||
{{APIComment|'Change model #47's name to "New_Name".}} | {{APIComment|'Change model #47's name to "New_Name".}} |
Revision as of 14:47, 14 July 2015
Member of: SynthesisAPI10Repository
Saves all updates to a model. Changes are reflected in the repository immediately upon refresh. Returns a Boolean value; when true, indicates a successful update.
Note that you can apply updates only to models that were created manually (i.e., models that were published from analyses cannot be updated via the API).
Syntax
object.Model.UpdateModel(m)
where object is a variable that represents a Repository object.
Parameters
Name | Description | |
---|---|---|
mborder="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse; text-align: left; cellborder" | ||
Name | Status | The cModel object to be updated. |
Example
These examples assume that a model with ID#47 and a project with ID#1 exist in the repository.
VBA
Dim MyRepository As New Repository ...'Add code to connect to a Synthesis repository.
'Get the model. If getting a local (as opposed to global) model, add code to specify the current project. 'For example, the following code retrieves model #47 from project #1. Dim AModel As cModel MyRepository.Project.SetCurrentProject(1) Set AModel = MyRepository.Model.GetModel(47)
'Change model #47's name to "New_Name". AModel.Name = "New Name"
'Apply the update to the model. Changes will be reflected in the repository. Call MyRepository.Model.UpdateModel(AModel)
VB.NET
Dim MyRepository As New Repository ...'Add code to connect to a Synthesis repository.
'Get the model. If getting a local (as opposed to global) model, add code to specify the current project. 'For example, the following code retrieves model #47 from project #1. Dim AModel As cModel MyRepository.Project.SetCurrentProject(1) AModel = MyRepository.Model.GetModel(47)
'Change model #47's name to "New_Name". AModel.Name = "New Name"
'Apply the update to the model. Changes will be reflected in the repository. MyRepository.Model.UpdateModel(AModel)