cGroupDelete Method

Deletes the specified group.

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

Parameters

Name
Type: SystemString
The name of an existing group.

Return Value

Type: Int32
Returns zero if the group is successfully deleted, otherwise it returns a nonzero value.
Remarks
An error will be returned if an attempt is made to delete the Group named "ALL".
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 group
       ret = SapModel.GroupDef.SetGroup("Group1")

    'delete group
       ret = SapModel.GroupDef.Delete("Group1")

   'close ETABS
       EtabsObject.ApplicationExit(False)

   'clean up variables
       SapModel = Nothing
       EtabsObject = Nothing
   End Sub
See Also