Checks if a load case is selected for output.
Namespace: ETABS2015Assembly: ETABS2015 (in ETABS2015.dll) Version: 15.0.0.0 (15.0.0.0)
int GetCaseSelectedForOutput(
string Name,
ref bool Selected
)
Function GetCaseSelectedForOutput ( _
Name As String, _
ByRef Selected As Boolean _
) As Integer
int GetCaseSelectedForOutput(
String^ Name,
bool% Selected
)
Parameters
- Name
- Type:
System String
The name of an existing load case.
- Selected
- Type: System Boolean
This item is True if the specified load case is to be selected for
output, otherwise it is False.
Return Value
Returns zero if the selected flag is successfully retrieved;
otherwise it returns nonzero.
Public Sub Example()
Dim SapModel As cSapModel
Dim EtabsObject As cOAPI
Dim ret As Integer = -1
Dim Selected As Boolean
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)
System.IO.Directory.CreateDirectory("c:\CSI_API_temp")
ret = SapModel.File.Save("C:\CSI_API_temp\example.edb")
ret = SapModel.Analyze.RunAnalysis
ret = SapModel.Results.Setup.DeselectAllCasesAndCombosForOutput
ret = SapModel.Results.Setup.SetCaseSelectedForOutput("DEAD")
ret = SapModel.Results.Setup.GetCaseSelectedForOutput("DEAD", Selected)
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 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