Customization > Automation Interface > Functions > For Models > SetModelComment function (automation interface)
SetModelComment function (automation interface)
Syntax:
SetModelComment (\\SQL\<server>@<instance>\<database>\<model>\<version>", "<text>")
Where:
<server> is a string that specifies the name of the server on which the Database resides. The case of the name must be correct.
<database> is a string that specifies the name of the Database that owns the Model for which you want to set a comment. The case of the name must be correct.
<model> is a string that specifies the name of the Model for which you want to set a comment. The case of the name must be correct.
<version> is a string that specifies the version of the Model for which you want to set a comment. If the Model has not been versioned, the version is 0.
<text> is a string that specifies the text you want to use for the comment.
The SetModelComment function sets the comment of a model version.
Examples
This example sets the model comment of version 0 of the MyModel model in the MyDatabase database to My Comment.
Set objManager = CreateObject("Studio.ModelManager")
objManager.SetModelComment("\\SQL\MyServer@MODELER\MyDatabase\MyModel\0","My Comment”)