Delete

Your Ad Here

Syntax

SapObject.SapModel.AreaObj.Delete

VB6 Procedure

Function Delete(ByVal Name As String, Optional ByVal ItemType As eItemType = Object) As Long

Parameters

Name

The name of an existing area object or group, depending on the value of the ItemType item.

ItemType

This is one of the following items in the eItemType enumeration:

Object = 0

Group = 1

SelectedObjects = 2

If this item is Object, the area object specified by the Name item is deleted.

If this item is Group, all of the area objects in the group specified by the Name item are deleted.

If this item is SelectedObjects, all of the selected area objects are deleted, and the Name item is ignored.

Remarks

The function deletes area objects.

The function returns zero if the area objects are successfully deleted; otherwise it returns a nonzero value.

VBA Example

Sub DeleteAreaObj()
   'dimension variables
      Dim SapObject As Sap2000.SapObject
      Dim SapModel As cSapModel
      Dim ret As Long

   '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.NewWall(2, 48, 2, 48)

   'delete area object
      ret = SapModel.AreaObj.Delete("4")

   'update view
      ret = SapModel.View.RefreshView(0, True)

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

Release Notes

Initial release in version 11.00.