SetPreference {Steel API RP2A LRFD97}

SetPreference

Syntax

SapObject.SapModel.DesignSteel.API_RP2A_LRFD97.SetPreference

VB6 Procedure

Function GetPreference(ByVal Item As Long, ByRef Value As Double) As Long

Parameters

Item

This is an integer between 1 and 11, inclusive, indicating the preference item considered.

1 = Framing type

2 = Tubular joint punching load method

3 = Consider deflection

4 = DL deflection limit, L/Value

5 = SDL + LL deflection limit, L/Value

6 = LL deflection limit, L/Value

7 = Total deflection limit, L/Value

8 = Total camber limit, L/Value

9 = Pattern live load factor

10 = Demand/capacity ratio limit

11 = Multi-response case design

Value

The value of the considered preference item.

1 = Framing type

1 = Moment Frame

2 = Braced Frame

2 = Tubular joint punching load method

1 = Punching Shear

2 = Nominal Load

3 = Consider deflection

0 = No

Any other value = Yes

4 = DL deflection limit, L/Value

Value > 0

5 = SDL + LL deflection limit, L/Value

Value > 0

6 = LL deflection limit, L/Value

Value > 0

7 = Total deflection limit, L/Value

Value > 0

8 = Total camber limit, L/Value

Value > 0

9 = Pattern live load factor

Value >= 0

10 = Demand/capacity ratio limit

Value > 0

11 = Multi-response case design

1 = Envelopes

2 = Step-by-step

3 = Last step

4 = Envelopes -- All

5 = Step-by-step -- All

Remarks

This function sets the value of a steel design preference item.

The function returns zero if the item is successfully set; otherwise it returns a nonzero value.

VBA Example

Sub SetSteelDesignPreferenceItemAPI_RP2A_LRFD97()

'dimension variables

Dim SapObject as cOAPI

Dim SapModel As cSapModel

Dim ret As Long

'create Sap2000 object

Set SapObject= New Sap2000v16.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 steel design code

ret= SapModel.DesignSteel.SetCode("API RP2A-LRFD 97")

'set preference item

ret= SapModel.DesignSteel.API_RP2A_LRFD97.SetPreference(1, 2)

'close Sap2000

SapObject.ApplicationExit False

Set SapModel= Nothing

Set SapObject= Nothing

End Sub

Release Notes

Initial release in version 11.03.

Changed Time history design item to Multi-response case design and added additional values in version 15.0.1.

See Also

GetPreference