DeleteCase

Your Ad Here

Syntax

SapObject.SapModel.RespCombo.DeleteCase

VB6 Procedure

Function DeleteCase(ByVal Name As String, ByVal CType As eCType, ByVal CName As String) As Long

Parameters

Name

The name of an existing response combination.

CType

This is one of the following items in the eCType enumeration:

ACase = 0

RCombo = 1

This item indicates whether the CName item is an analysis case (ACase) or a response combination (RCombo).

CName

The name of the analysis case or response combination to be deleted from the specified combination.

Remarks

This function deletes one analysis case or response combination from the list of cases included in the specified response combination.

The function returns zero if the item is successfully deleted, otherwise it returns a nonzero value.

VBA Example

Sub DeleteComboCase()
   'dimension variables
      Dim SapObject As Sap2000.SapObject
      Dim SapModel As cSapModel
      Dim ret As Long

   '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)

   'add combo
      ret = SapModel.RespCombo.Add("COMB1", 0)

   'add analysis case to combo
      ret = SapModel.RespCombo.SetCaseList("COMB1", ACase, "DEAD", 1.4)

   'delete analysis case from combo
      ret = SapModel.RespCombo.DeleteCase("COMB1", ACase, "DEAD")

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

Release Notes

Initial release in version 11.00.