DeleteRestraint

Your Ad Here

Syntax

SapObject.SapModel.PointObj.DeleteRestraint

VB6 Procedure

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

Parameters

Name

The name of a point object or a group depending on the value selected for ItemType item.

ItemType

This is one of the following items from the eItemType enumeration.

Object = 0

Group = 1

SelectedObjects = 2

If Object is selected, the Name item refers to a point object. The restraint assignments for that point object are removed.

If Group is selected, the Name item refers to a group. The restraint assignments for all point objects in the group are removed.

If SelectedObjects is selected, the Name item is ignored. The restraint assignments for all selected point objects are removed.

Remarks

This function deletes all restraint assignments from the specified point object(s).

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

VBA Example

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

   'delete joint restraint assignment
      ret = SapModel.PointObj.DeleteRestraint("1")

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

Release Notes

Initial release in version 11.00.