Repository.Model.UpdateModel: Difference between revisions
Jump to navigation
Jump to search
Alex Ulanov (talk | contribs) |
Kate Racaza (talk | contribs) No edit summary |
||
Line 1: | Line 1: | ||
{{Template: | {{Template:APIBreadcrumb|10|Repository}} | ||
{{Template: | {{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. | |||
== Syntax== | == Syntax == | ||
UpdateModel( m | ''object''.'''Model.UpdateModel(''m'')''' | ||
where ''object'' is a variable that represents a Repository object. | |||
== | === Parameters === | ||
{| {{APITable}} | |||
Dim MyRepository As New Repository | |- | ||
|m{{APIParam|Required}}||The '''[[CModel Class|cModel]]''' object to be updated. | |||
{{APIComment|' | |} | ||
== Example == | |||
{{APIComment|'Get the | '''VBA'''<br> | ||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | |||
{{APIComment|...'Add code to connect to a Synthesis repository.}}<br> | |||
{{APIComment|'Get the model. If getting a local model, add code to specify the current project.}} | |||
{{APIComment|' | {{APIComment|'For example, the following code retrieves model #47 from project #1.}} | ||
Dim AModel | {{APIPrefix|Dim}} AModel {{APIPrefix|As}} cModel | ||
AModel = MyRepository.Model.GetModel( | MyRepository.Project.SetCurrentProject(1) | ||
AModel = MyRepository.Model.GetModel(47)<br> | |||
{{APIComment|'Change | {{APIComment|'Change model #47's name to "New Name".}} | ||
AModel.Name = "New Name" | {{APIPrefix|Set}} AModel.Name = "New Name"<br> | ||
{{APIComment|'Apply the update to the model. Changes will be reflected in the repository.}} | |||
{{APIComment|' | MyRepository.Model.UpdateModel(AModel) | ||
Revision as of 23:26, 13 July 2015
Member of: SynthesisAPI10Repository
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.
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
VBA
Dim MyRepository As New Repository ...'Add code to connect to a Synthesis repository.
'Get the model. If getting a local 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". Set AModel.Name = "New Name"
'Apply the update to the model. Changes will be reflected in the repository. MyRepository.Model.UpdateModel(AModel)