cGridSysChangeName Method

Changes the name of a defined grid system.

Namespace:  ETABS2016
Assembly:  ETABS2016 (in ETABS2016.dll) Version: 16.0.0.0 (16.0.0.0)
Syntax
Copy
int ChangeName(
	string Name,
	string NewName
)

Parameters

Name
Type: SystemString
The existing name of a defined grid system.
NewName
Type: SystemString
The new name for the grid system.

Return Value

Type: Int32
Returns zero if the new name is successfully applied, otherwise it returns a nonzero value.
Remarks
Changing the name of the Global grid system will fail and return an error.
Examples
VB
Copy
Public Sub Example()
   Dim SapModel As cSapModel
   Dim EtabsObject As cOAPI
   Dim ret As Integer = -1

'create ETABS object
   EtabsObject = CreateObject("CSI.ETABS.API.ETABSObject")

'start ETABS application
  ret = EtabsObject.ApplicationStart()

'create SapModel object
   SapModel = EtabsObject.SapModel

'initialize model
   ret = SapModel.InitializeNewModel()

'create steel deck template model
   ret = SapModel.File.NewSteelDeck(4, 12, 12, 4, 4, 24, 24)

'define new grid system
   ret = SapModel.GridSys.SetGridSys("GridSysA", 1000, 1000, 0, 0, 0, 0)

'change name of new grid system
   ret = SapModel.GridSys.ChangeName("GridSysA", "MyChangedCSysA")

'close ETABS
   EtabsObject.ApplicationExit(False)

'clean up variables
   SapModel = Nothing
   EtabsObject = Nothing

End Sub
See Also