SetModifiers {Frame}

SetModifiers

Syntax

SapObject.SapModel.PropFrame.SetModifiers

VB6 Procedure

Function SetModifiers(ByVal Name As String, ByRef Value() As Double) As Long

Parameters

Name

The name of an existing frame section property.

Value

This is an array of eight unitless modifiers.

Value(0) = Cross sectional area modifier

Value(1) = Shear area in local 2 direction modifier

Value(2) = Shear area in local 3 direction modifier

Value(3) = Torsional constant modifier

Value(4) = Moment of inertia about local 2 axis modifier

Value(5) = Moment of inertia about local 3 axis modifier

Value(6) = Mass modifier

Value(7) = Weight modifier

Remarks

This function assigns property modifiers to a frame section property. The default value for all modifiers is one.

The function returns zero if the modifiers are successfully assigned; otherwise it returns a nonzero value.

VBA Example

Sub AssignFramePropModifiers()

'dimension variables

Dim SapObject as cOAPI

Dim SapModel As cSapModel

Dim ret As Long

Dim i As Long

Dim Value() As Double

'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, 3, 124, 3, 200)

'assign modifiers

ReDim Value(7)

For i = 0 To 7

Value(i) = 1

Next i

Value(5) = 100

ret = SapModel.PropFrame.SetModifiers("FSEC1", Value)

'close Sap2000

SapObject.ApplicationExit False

Set SapModel = Nothing

Set SapObject = Nothing

End Sub

Release Notes

Initial release in version 11.02.

See Also

GetModifiers