DeleteLoadDeformation

Syntax

SapObject.SapModel.CableObj.DeleteLoadDeformation

VB6 Procedure

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

Parameters

Name

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

LoadCase

The name of a defined load case.

ItemType

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

Object = 0

Group = 1

SelectedObjects = 2

If this item is Object, the load assignments are deleted for the cable object specified by the Name item.

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

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

Remarks

This function deletes the deformation load assignments to the specified cable objects for the specified load case.

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

VBA Example

Sub DeleteCableDeformationLoad()
   'dimension variables
      Dim SapObject As Sap2000.SapObject
      Dim SapModel As cSapModel
      Dim ret As Long
      Dim Name As String

   '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.New2DFrame(PortalFrame, 3, 124, 3, 200)

   'add cable object by points
      ret = SapModel.CableObj.AddByPoint("1", "6", Name)

   'set cable data
      ret = SapModel.CableObj.SetCableData(Name, 7, 1, 0, 0, 24)

   'assign cable deformation loads
      ret = SapModel.CableObj.SetLoadDeformation("ALL", "DEAD", 2, Group)

   'delete cable deformation load
      ret = SapModel.CableObj.DeleteLoadDeformation(Name, "DEAD")

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

Release Notes

Initial release in version 11.00.