DeleteResults Method

cAnalyze DeleteResults Method

CSi API ETABS 2015

Deletes results for load cases.

Namespace: ETABS2015
Assembly: ETABS2015 (in ETABS2015.dll) Version: 15.0.0.0 (15.0.0.0)

Syntax

int DeleteResults(
	string Name,
	bool All = false
)

int DeleteResults(
	string Name,
	bool All = false
)

Function DeleteResults ( _
	Name As String, _
	Optional All As Boolean = False _
) As Integer

Function DeleteResults ( _
	Name As String, _
	Optional All As Boolean = False _
) As Integer

int DeleteResults(
	String^ Name, 
	bool All = false
)

int DeleteResults(
	String^ Name, 
	bool All = false
)

Parameters

Name: Type: System String
The name of an existing load case that is to have its results deleted.
This item is ignored when the All item is True.

All (Optional): Type: System Boolean
If this item is True, the results are deleted for all load cases, and the Name item is ignored.

Return Value

Returns zero if the results are successfully deleted; otherwise it returns a nonzero value.

Remarks

Examples

C++

Copy to Clipboard Print

Public 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)

   'run analysis
       System.IO.Directory.CreateDirectory("c:\CSI_API_temp")
       ret = SapModel.File.Save("C:\CSI_API_temp\example.edb")
       ret = SapModel.Analyze.RunAnalysis

   'delete load case results
       ret = SapModel.Analyze.DeleteResults("MODAL")

   'close ETABS
       EtabsObject.ApplicationExit(False)

   'clean up variables
       SapModel = Nothing
       EtabsObject = Nothing 
   End Sub

Public 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)

   'run analysis
       System.IO.Directory.CreateDirectory("c:\CSI_API_temp")
       ret = SapModel.File.Save("C:\CSI_API_temp\example.edb")
       ret = SapModel.Analyze.RunAnalysis

   'delete load case results
       ret = SapModel.Analyze.DeleteResults("MODAL")

   'close ETABS
       EtabsObject.ApplicationExit(False)

   'clean up variables
       SapModel = Nothing
       EtabsObject = Nothing 
   End Sub