ChangeName {Link Object}

ChangeName

Syntax

SapObject.SapModel.LinkObj.ChangeName

VB6 Procedure

Function ChangeName(ByVal Name As String, ByVal NewName As String) As Long

Parameters

Name

The existing name of a defined link object.

NewName

The new name for the link object.

Remarks

This function applies a new name to an link object.

The function returns zero if the new name is successfully applied; otherwise it returns a nonzero value.

VBA Example

Sub ChangeLinkObjName()

'dimension variables

Dim SapObject as cOAPI

Dim SapModel As cSapModel

Dim ret As Long

Dim Name As String

'create Sap2000 object

Set SapObject = CreateObject("CSI.SAP2000.API.SapObject")

'start Sap2000 application

SapObject.ApplicationStart

'create SapModel object

Set SapModel = SapObject.SapModel

'initialize model

ret = SapModel.InitializeNewModel

'create model from template

ret = SapModel.File.New2DFrame(PortalFrame, 2, 144, 2, 288)

'add link object by points

ret = SapModel.LinkObj.AddByPoint("1", "5", Name)

'refresh view

ret = SapModel.View.RefreshView

'change name

ret = SapModel.LinkObj.ChangeName(Name, "MyLink")

'close Sap2000

SapObject.ApplicationExit False

Set SapModel = Nothing

Set SapObject = Nothing

End Sub

Release Notes

Initial release in version 11.00.

See Also