DeselectAllCasesAndCombosForOutput Method

cAnalysisResultsSetup DeselectAllCasesAndCombosForOutput Method

CSi API ETABS 2015

Deselects all load cases and response combinations for output.

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

Syntax

int DeselectAllCasesAndCombosForOutput()

int DeselectAllCasesAndCombosForOutput()

Function DeselectAllCasesAndCombosForOutput As Integer

Function DeselectAllCasesAndCombosForOutput As Integer

int DeselectAllCasesAndCombosForOutput()

int DeselectAllCasesAndCombosForOutput()

Return Value

Returns zero if the cases and combos are successfully deselected; 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 
       Dim Selected As Boolean 

   '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

   'deselect all cases and combos
       ret = SapModel.Results.Setup.DeselectAllCasesAndCombosForOutput

   'set case selected for output
       ret = SapModel.Results.Setup.SetCaseSelectedForOutput("DEAD")

   'check if case is selected
       ret = SapModel.Results.Setup.GetCaseSelectedForOutput("DEAD", Selected)

   '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 
       Dim Selected As Boolean 

   '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

   'deselect all cases and combos
       ret = SapModel.Results.Setup.DeselectAllCasesAndCombosForOutput

   'set case selected for output
       ret = SapModel.Results.Setup.SetCaseSelectedForOutput("DEAD")

   'check if case is selected
       ret = SapModel.Results.Setup.GetCaseSelectedForOutput("DEAD", Selected)

   'close ETABS
       EtabsObject.ApplicationExit(False)

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