Deletes the specified load pattern.
Namespace: ETABS2015Assembly: ETABS2015 (in ETABS2015.dll) Version: 15.0.0.0 (15.0.0.0)
int Delete(
string Name
)
Function Delete ( _
Name As String _
) As Integer
int Delete(
String^ Name
)
Parameters
- Name
- Type:
System String
The name of an existing load pattern.
Return Value
Returns zero if the load pattern is successfully deleted,
otherwise it returns a nonzero value.
The load pattern is not deleted and the function returns an error
if the load pattern is assigned to an load case or
if it is the only defined load pattern.
Public Sub Example()
Dim SapModel As cSapModel
Dim EtabsObject As cOAPI
Dim ret As Integer = -1
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)
ret = SapModel.LoadPatterns.Delete("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
'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)
'delete load case
ret = SapModel.LoadPatterns.Delete("DEAD")
'Note: ret in the above line returns 1, indicating an error.
'This is because the load pattern DEAD is assigned to
'load case DEAD.
'close ETABS
EtabsObject.ApplicationExit(False)
'clean up variables
SapModel = Nothing
EtabsObject = Nothing
End Sub