Deletes all point force load assignments, for the specified load pattern,
from the specified point object(s).
Namespace: ETABS2015Assembly: ETABS2015 (in ETABS2015.dll) Version: 15.0.0.0 (15.0.0.0)
int DeleteLoadForce(
string Name,
string LoadPat,
eItemType ItemType = eItemType.Objects
)
Function DeleteLoadForce ( _
Name As String, _
LoadPat As String, _
Optional ItemType As eItemType = eItemType.Objects _
) As Integer
int DeleteLoadForce(
String^ Name,
String^ LoadPat,
eItemType ItemType = eItemType::Objects
)
Parameters
- Name
- Type:
System String
The name of an existing point object or group depending on the
value of the ItemType item.
- LoadPat
- Type: System String
The name of the load pattern for the point force load.
- ItemType (Optional)
- Type: ETABS2015 eItemType
This is one of the following items in the eItemType enumeration:
- Object = 0
- Group = 1
- SelectedObjects = 2
If Objects is selected, the Name
item refers to a point object. The load assignments,
for the specified load pattern, made to that point object, are removed.
If Group is selected, the Name
item refers to a group. The load assignments, for the specified
load pattern, made to all point objects in the group, are removed.
If SelectedObjects is selected, the Name
item is ignored. The load assignments, for the specified load pattern,
made to all selected point objects, are removed.
Return Value
Returns zero if the load assignments are successfully deleted,
otherwise it returns a nonzero value.
Public Sub Example()
Dim SapModel As cSapModel
Dim EtabsObject As cOAPI
Dim ret As Integer = -1
Dim Value as Double()
EtabsObject = CreateObject("CSI.ETABS.API.ETABSObject")
ret = EtabsObject.ApplicationStart()
SapModel = EtabsObject.SapModel
ret = SapModel.InitializeNewModel()
ret = SapModel.File.NewSteelDeck(4, 12, 12, 4, 4, 24, 24)
Redim Value(5)
Value(0) = 10
ret = SapModel.PointObj.SetLoadForce("2", "DEAD", Value)
ret = SapModel.PointObj.DeleteLoadForce("2", "DEAD")
EtabsObject.ApplicationExit(False)
SapModel = Nothing
EtabsObject = Nothing
End SubPublic Sub Example()
Dim SapModel As cSapModel
Dim EtabsObject As cOAPI
Dim ret As Integer = -1
Dim Value as Double()
'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)
'add point load
Redim Value(5)
Value(0) = 10
ret = SapModel.PointObj.SetLoadForce("2", "DEAD", Value)
'delete point load
ret = SapModel.PointObj.DeleteLoadForce("2", "DEAD")
'close ETABS
EtabsObject.ApplicationExit(False)
'clean up variables
SapModel = Nothing
EtabsObject = Nothing
End Sub