DeleteSpring {Area Object}

DeleteSpring

Syntax

SapObject.SapModel.AreaObj.DeleteSpring

VB6 Procedure

Function DeleteSpring(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 spring assignments are deleted for the area object specified by the Name item.

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

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

Remarks

This function deletes all spring assignments for the specified area objects.

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

VBA Example

Sub DeleteAreaObjectSprings()

'dimension variables

Dim SapObject as cOAPI

Dim SapModel As cSapModel

Dim ret As Long

Dim Vec() As Double

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

'assign springs to area objects

ReDim Vec(2)

ret = SapModel.AreaObj.SetSpring("ALL", 1, 1, 1, "", -1, 1, 3, True, Vec, 0, False, "Local", Group)

'delete springs

ret = SapModel.AreaObj.DeleteSpring("3")

'close Sap2000

SapObject.ApplicationExit False

Set SapModel = Nothing

Set SapObject = Nothing

End Sub

Release Notes

Initial release in version 11.00.

See Also

GetSpring

SetSpring