GetModifiers {Area}

GetModifiers

Syntax

SapObject.SapModel.PropArea.GetModifiers

VB6 Procedure

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

Parameters

Name

The name of an existing area property.

Value

This is an array of 10 unitless modifiers.

Value(0) = Membrane f11 modifier

Value(1) = Membrane f22 modifier

Value(2) = Membrane f12 modifier

Value(3) = Bending m11 modifier

Value(4) = Bending m22 modifier

Value(5) = Bending m12 modifier

Value(6) = Shear v13 modifier

Value(7) = Shear v23 modifier

Value(8) = Mass modifier

Value(9) = Weight modifier

Remarks

This function retrieves the modifier assignments for an area property. The default value for all modifiers is one.

The function returns zero if the modifier assignments are successfully retrieved; otherwise it returns a nonzero value.

VBA Example

Sub GetAreaPropModifiers()

'dimension variables

Dim SapObject as cOAPI

Dim SapModel As cSapModel

Dim ret As Long

Dim i As Long

Dim MyValue() As Double

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.NewWall(2, 48, 2, 48)

'assign modifiers

ReDim MyValue(9)

For i = 0 To 9

MyValue(i) = 1

Next i

MyValue(0) = 0.1

ret = SapModel.PropArea.SetModifiers("ASEC1", MyValue)

'get modifiers

ret = SapModel.PropArea.GetModifiers("ASEC1", Value)

'close Sap2000

SapObject.ApplicationExit False

Set SapModel = Nothing

Set SapObject = Nothing

End Sub

Release Notes

Initial release in version 11.02.

See Also

SetModifiers