cAnalyzeGetRunCaseFlag Method

Retrieves the run flags for all analysis cases.

Namespace:  ETABS2016
Assembly:  ETABS2016 (in ETABS2016.dll) Version: 16.0.0.0 (16.0.0.0)
Syntax
Copy
int GetRunCaseFlag(
	ref int NumberItems,
	ref string[] CaseName,
	ref bool[] Run
)

Parameters

NumberItems
Type: SystemInt32
The number of load cases for which the run flag is reported.
CaseName
Type: SystemString
Run
Type: SystemBoolean
This is an array of boolean values indicating if the specified load case is to be run.

Return Value

Type: Int32
Returns zero if the flags are successfully retrieved; otherwise it returns a nonzero value.
Remarks
Examples
VB
Copy
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 Run() 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)

   'set load case run flag
       ret = SapModel.Analyze.SetRunCaseFlag("MODAL", False)

   'get load case run flags
       ret = SapModel.Analyze.GetRunCaseFlag(NumberItems, CaseName, Run)

   'close ETABS
       EtabsObject.ApplicationExit(False)

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