PropRebar.ChangeName

ChangeName

Syntax

SapObject.SapModel.PropRebar.ChangeName

VB6 Procedure

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

Parameters

Name

The existing name of a defined rebar property.

NewName

The new name for the rebar property.

Remarks

This function changes the name of an existing rebar property.

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

VBA Example

Sub ChangeRebarPropName()

 'dimension variables

 Dim SapObject as cOAPI

 Dim SapModel As cSapModel

 Dim ret As Long

 '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)

 'set new rebar property

 ret = SapModel.PropRebar.SetProp("R1", 1, 1.128)

 'change name of rebar property

 ret = SapModel.PropRebar.ChangeName("R1", "MyRebar")

 'close Sap2000

 SapObject.ApplicationExit False

 Set SapModel = Nothing

 Set SapObject = Nothing

 End Sub

Release Notes

Initial release in v21.2.0.

See Also