SetDesignType

SetDesignType

Syntax

SapObject.SapModel.LoadCases.SetDesignType

VB6 Procedure

Function SetDesignType(ByVal Name As String, ByVal DesignTypeOption As Long, Optional ByVal DesignType As eLoadPatternType = LTYPE_DEAD) As Long

Parameters

Name

The name of an existing load case.

DesignTypeOption

This is one of the following options for the DesignType item.

0 = Program determined

1 = User specified

DesignType

This item only applies when the DesignTypeOption is 1 (user specified). It is one of the following items in the eLoadPatternType enumeration.

LTYPE_DEAD = 1

LTYPE_SUPERDEAD = 2

LTYPE_LIVE = 3

LTYPE_REDUCELIVE = 4

LTYPE_QUAKE = 5

LTYPE_WIND= 6

LTYPE_SNOW = 7

LTYPE_OTHER = 8

LTYPE_MOVE = 9

LTYPE_TEMPERATURE = 10

LTYPE_ROOFLIVE = 11

LTYPE_NOTIONAL = 12

LTYPE_PATTERNLIVE = 13

LTYPE_WAVE= 14

LTYPE_BRAKING = 15

LTYPE_CENTRIFUGAL = 16

LTYPE_FRICTION = 17

LTYPE_ICE = 18

LTYPE_WINDONLIVELOAD = 19

LTYPE_HORIZONTALEARTHPRESSURE = 20

LTYPE_VERTICALEARTHPRESSURE = 21

LTYPE_EARTHSURCHARGE = 22

LTYPE_DOWNDRAG = 23

LTYPE_VEHICLECOLLISION = 24

LTYPE_VESSELCOLLISION = 25

LTYPE_TEMPERATUREGRADIENT = 26

LTYPE_SETTLEMENT = 27

LTYPE_SHRINKAGE = 28

LTYPE_CREEP = 29

LTYPE_WATERLOADPRESSURE = 30

LTYPE_LIVELOADSURCHARGE = 31

LTYPE_LOCKEDINFORCES = 32

LTYPE_PEDESTRIANLL = 33

LTYPE_PRESTRESS = 34

LTYPE_HYPERSTATIC = 35

LTYPE_BOUYANCY = 36

LTYPE_STREAMFLOW = 37

LTYPE_IMPACT = 38

LTYPE_CONSTRUCTION = 39

Remarks

This function sets the design type for the specified load case.

The function returns zero if the type is successfully set; otherwise it returns nonzero.

VBA Example

Sub SetLoadCaseDesignType

'dimension variables

Dim SapObject as cOAPI

Dim SapModel As cSapModel

Dim ret As Long

'create Sap2000 object

Set SapObject = CreateObject("CSI.SAP2000.API.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, 2, 144, 2, 288)

'set load case design type

ret = SapModel.LoadCases.SetDesignType("DEAD", 1, LTYPE_SUPERDEAD)

'close Sap2000

SapObject.ApplicationExit False

Set SapModel = Nothing

Set SapObject = Nothing

End Sub

Release Notes

Initial release in version 12.00.

See Also

GetType_1