Retrieves the status for all load cases.
Namespace: ETABS2015Assembly: ETABS2015 (in ETABS2015.dll) Version: 15.0.0.0 (15.0.0.0)
int GetCaseStatus(
ref int NumberItems,
ref string[] CaseName,
ref int[] Status
)
int GetCaseStatus(
ref int NumberItems,
ref string[] CaseName,
ref int[] Status
)
Function GetCaseStatus ( _
ByRef NumberItems As Integer, _
ByRef CaseName As String(), _
ByRef Status As Integer() _
) As Integer
int GetCaseStatus(
int% NumberItems,
array<String^>^% CaseName,
array<int>^% Status
)
int GetCaseStatus(
int% NumberItems,
array<String^>^% CaseName,
array<int>^% Status
)
Parameters
- NumberItems
- Type:
System Int32
The number of load cases for which the status is reported.
- CaseName
- Type: System String
This is an array that includes the name of each analysis case
for which the status is reported.
- Status
- Type: System Int32
This is an array containing integers from 1 to 4,
indicating the load case status.
- Not run
- Could not start
- Not finished
- Finished
Return Value
Returns zero if the status is successfully retrieved;
otherwise it returns a nonzero value.
Public Sub Example()
Dim SapModel As cSapModel
Dim EtabsObject As cOAPI
Dim ret As Integer = -1
Dim NumberItems As Integer
Dim CaseName() As String
Dim Status() As Integer
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.Analyze.SetRunCaseFlag("MODAL", False)
System.IO.Directory.CreateDirectory("c:\CSI_API_temp")
ret = SapModel.File.Save("C:\CSI_API_temp\example.edb")
ret = SapModel.Analyze.RunAnalysis
ret = SapModel.Analyze.GetCaseStatus(NumberItems, CaseName, Status)
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 NumberItems As Integer
Dim CaseName() As String
Dim Status() As Integer
'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)
'set load case run flag
ret = SapModel.Analyze.SetRunCaseFlag("MODAL", False)
'run analysis
System.IO.Directory.CreateDirectory("c:\CSI_API_temp")
ret = SapModel.File.Save("C:\CSI_API_temp\example.edb")
ret = SapModel.Analyze.RunAnalysis
'get load case status
ret = SapModel.Analyze.GetCaseStatus(NumberItems, CaseName, Status)
'close ETABS
EtabsObject.ApplicationExit(False)
'clean up variables
SapModel = Nothing
EtabsObject = Nothing
End Sub