GetType

Your Ad Here

Syntax

SapObject.SapModel.RespCombo.GetType

VB6 Procedure

Function GetType(ByVal Name As String, ByRef ComboType As Long) As Long

Parameters

Name

The name of an existing response combination.

ComboType

This is 0, 1, 2, 3 or 4 indicating the response combination type.

0 = Linear Additive

1 = Envelope

2 = Absolute Additive

3 = SRSS

4 = Range Additive

Remarks

This function retrieves the combination type for specified response combination.

The function returns zero if the type is successfully retrieved, otherwise it returns a nonzero value.

VBA Example

Sub GetComboType()
   'dimension variables
      Dim SapObject As Sap2000.SapObject
      Dim SapModel As cSapModel
      Dim ret As Long
      Dim ComboType 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", 2)

   'get combo type
      ret = SapModel.RespCombo.GetType("COMB1", ComboType )

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

Release Notes

Initial release in version 11.00.