ChangeName

Your Ad Here

Syntax

SapObject.SapModel.CableObj.ChangeName

VB6 Procedure

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

Parameters

Name

The existing name of a defined cable object.

NewName

The new name for the cable object.

Remarks

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

VBA Example

Sub ChangeCableObjName()
   'dimension variables
      Dim SapObject As Sap2000.SapObject
      Dim SapModel As cSapModel
      Dim ret As Long
      Dim Name As String

   'create Sap2000 object
      Set SapObject = New SAP2000.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, 3, 124, 3, 200)

   'add cable object by points
      ret = SapModel.CableObj.AddByPoint("1", "6", Name)

   'change name
      ret = SapModel.CableObj.ChangeName(Name, "MyCable")

   'close Sap2000
      SapObject.ApplicationExit False
      Set SapModel = Nothing
      Set SapObject = Nothing
End Sub

Release Notes

Initial release in version 11.00.