Delete Method

cGroup Delete Method

CSi API ETABS 2015

Deletes the specified group.

Namespace: ETABS2015
Assembly: ETABS2015 (in ETABS2015.dll) Version: 15.0.0.0 (15.0.0.0)

Syntax

int Delete(
	string Name
)

int Delete(
	string Name
)

Function Delete ( _
	Name As String _
) As Integer

Function Delete ( _
	Name As String _
) As Integer

int Delete(
	String^ Name
)

int Delete(
	String^ Name
)

Parameters

Name: Type: System String
The name of an existing group.

Return Value

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

C++

Copy to Clipboard Print

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

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