GetCaseSelectedForOutput

Your Ad Here

Syntax

SapObject.SapModel.Results.Setup.GetCaseSelectedForOutput

VB6 Procedure

Function GetCaseSelectedForOutput(ByVal Name As String, ByRef Selected As Boolean) As Long

Parameters

Name

The name of an existing analysis case.

Selected

This item is True if the specified analysis case is selected for output.

Remarks

This function checks if an analysis case is selected for output.

The function returns 0 if the selected flag is successfully retrieved, otherwise it returns nonzero.

VBA Example

Sub GetAnalysisCaseSelected()
   'dimension variables
      Dim SapObject As Sap2000.SapObject
      Dim SapModel As cSapModel
      Dim ret As Long
      dim Selected As Boolean

   'create Sap2000 object
      Set SapObject = New SAP2000.SapObject

   'start Sap2000 application
      SapObject.ApplicationStart

   'create SapModel object
      Set SapModel = SapObject.SapModel

   'initialize model
      ret = SapModel.InitializeNewModel

   'create model from template
      ret = SapModel.File.New2DFrame(PortalFrame, 3, 124, 3, 200)

   'run analysis
      ret = SapModel.File.Save("C:\SapAPI\x.sdb")
      ret = SapModel.Analyze.RunAnalysis

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

   'close Sap2000
      SapObject.ApplicationExit False
      Set SapModel = Nothing
      Set SapObject = Nothing
End Sub

Release Notes

Initial release in version 11.00.