GetModelComment function (automation interface)

Customization > Automation Interface > Functions > For Models > GetModelComment function (automation interface)

Syntax:

GetModelComment (\\SQL\<server>@<instance>\<database>\<model>\<version>")

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 Repository that owns the Model from which you want to get the comment. The case of the name must be correct.

• <model> is a string that specifies the name of the Model from which you want to get the comment. The case of the name must be correct.

• <version> is a string that specifies the version of the Model from which you want to get the comment. If the Model has not been versioned, the version is 0.

The GetModelComment function gets the comment of a model version.

This function returns the comment property from the model version.

Examples

This example gets the model comment of version 0 of the MyModel model in the MyDatabase database.

Set objManager = CreateObject("Studio.ModelManager")
strComment = objManager.GetModelComment("\\SQL\MyServer@MODELER\MyDatabase\MyModel\0")