GetOverwrite {Euro06}

GetOverwrite

Syntax

SapObject.SapModel.Design
ColdFormed.EuroCold06.GetOverwrite

VB6 Procedure

Function GetOverwrite(ByVal Name As String, ByVal Item 
 As Long, ByRef Value As Double, ByRef ProgDet As Boolean) As Long

Parameters

Name

The name of a frame object with a cold-formed steel 
 frame design procedure.

Item

This is an integer between 1 and 34, inclusive, indicating 
 the overwrite item considered.

1 = Demand/capacity ratio limit

2 = Live load reduction factor

3 = Yield stress, Fy

4 = Net area to total area ratio

5 = Unbraced length ratio, y-y

6 = Unbraced length ratio, z-z

7 = Unbraced length ratio, LTB

8 = Effective length factor sway, K
2y

9 = Effective length factor sway, K
2z

10 = Effective length factor, K LTB

11 = Effective length factor braced, K
1y

12 = Effective length factor braced, K
1z

13 = Bending coefficient, C1

14 = Bending coefficient, C
2

15 = Bending coefficient, C
3

16 = Moment coefficient, kyy

17 = Moment coefficient, kzz

18 = Moment coefficient, kzy

19 = Moment coefficient, kyz

20 = Column buckling curve, y-y

21 = Column buckling curve, z-z

22 = Buckling curve for LTB

23 = Elastic torsional buckling force, 
 Ncr T

24 = Elastic torsional-flexural buckling 
 force, Ncr TF

25 = Compressive capacity, NRk

26 = Tensile capacity, Nt.Rd

27 = Bending capacity about the y-y axis, 
 MyRk

28 = Bending capacity about the z-z axis, 
 MzRk

29 = Shear capacity along z-z axis, Vbz.Rd

30 = Shear capacity along y-y axis, Vby.Rd

31 = Warping coefficient, k
w

32 = Coordinate of load application, z
a

33 = Lateral-torsional buckling moment 
 capacity, M
cr

34 = Member buckling interaction equation

Value

The value of the considered overwrite item.

1 = Demand/capacity ratio limit

Value 
 >= 0; 0 means use program determined value.

2 = Live load reduction factor

Value 
 >= 0; 0 means use program determined value.

3 = Yield stress, Fy

Value 
 >= 0; 0 means use program determined value. [F/L
2
]

4 = Net area to total area ratio

Value 
 >= 0; 0 means use program default value.

5 = Unbraced length ratio, y-y

Value 
 >= 0; 0 means use program determined value.

6 = Unbraced length ratio, z-z

Value 
 >= 0; 0 means use program determined value.

7 = Unbraced length ratio, LTB

Value 
 >= 0; 0 means use program determined value.

8 = Effective length factor sway, K
2y

Value >= 
 0; 0 means use program determined value.

9 = Effective length factor sway, K
2z

Value 
 >= 0; 0 means use program determined value.

10 = Effective length factor, K LTB

Value 
 >= 0; 0 means use program determined value.

11 = Effective length factor braced, K
1y

Value 
 >= 0; 0 means use program determined value.

12 = Effective length factor braced, K
1z

Value 
 >= 0; 0 means use program determined value.

13 = Bending coefficient, C1

Value 
 >= 0; 0 means use program determined value.

14 = Bending coefficient, C
2

Value >= 
 0; 0 means use program determined value.

15 = Bending coefficient, C
3

Value 
 >= 0; 0 means use program determined value.

16 = Moment coefficient, kyy 

Value 
 >= 0; 0 means use program determined value.

17 = Moment coefficient, kzz 

Value 
 >= 0; 0 means use program determined value.

18 = Moment coefficient, kzy

Value 
 >= 0; 0 means use program determined value.

19 = Moment coefficient, kyz

Value 
 >= 0; 0 means use program determined value.

20 = Column buckling curve, y-y

0 
 = Program default

1 
 = a0

2 
 = a

3 
 = b

4 
 = c

5 
 = d

21 = Column buckling curve, z-z

0 
 = Program default

1 
 = a0

2 
 = a

3 
 = b

4 
 = c

5 
 = d

22 = Buckling curve for LTB

0 
 = Program default

1 
 = a0

2 
 = a

3 
 = b

4 
 = c

5 
 = d

23 = Elastic torsional buckling force, 
 Ncr T

Value 
 >= 0; 0 means use program determined value. [F]

24 = Elastic torsional-flexural buckling 
 force, Ncr TF

Value 
 >= 0; 0 means use program determined value. [F]

25 = Compressive capacity, NRk

Value 
 >= 0; 0 means use program determined value. [F]

26 = Tensile capacity, Nt.Rd

Value 
 >= 0; 0 means use program determined value. [F]

27 = Bending capacity about the y-y axis, 
 MyRk

Value 
 >= 0; 0 means use program determined value. [FL]

28 = Bending capacity about the z-z axis, 
 MzRk

Value 
 >= 0; 0 means use program determined value. [FL]

29 = Shear capacity along z-z axix, Vbz.Rd

Value 
 >= 0; 0 means use program determined value. [F]

30 = Shear capacity along y-y axis, Vby.Rd

Value 
 >= 0; 0 means use program determined value. [F]

31 = Warping coefficient, k
w

 (used in M
cr
 calculation)

0.5 
 =<Value =< 1; 0 means use program determined value which is defaulted 
 to 1.0.

32 = Coordinate of load application, z
a

 (used in M
cr
 calculation)

33 = Lateral-torsional buckling moment 
 capacity, M
cr

Value 
 >= 0; 0 means use program determined value. [FL]

34 = Member buckling interaction equations

1 
 = Equations 6.61 and 6.62 in EN 1993-1-1:2005

2 = Equation 6.36 in EN 1993-1-3:2006 for each 
 axis of bending separately

3 
 = Equation 6.36 in EN 1993-1-3:2006 for both axes of bending simultaneously

4 
 = Equation 6.61 and 6.62 in EN 1993-1-1:2005 and Equation 6.36 in EN 1993-1-3:2006 
 for each axis of bending separately

5 
 = Equation 6.61 and 6.62 in EN 1993-1-1:2005 and Equation 6.36 in EN 1993-1-3:2006 
 for both axes of bending simultaneously

ProgDet

If this item is True, the specified value is program 
 determined.

Remarks

This function retrieves the value of a steel design 
 overwrite item.

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

VBA Example

Sub GetSteelDesignOverwriteItemEuroCold06()

'dimension variables

Dim SapObject as cOAPI

Dim SapModel As cSapModel

Dim ret As Long

Dim Value As Double

Dim ProgDet As Boolean

'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 steel design code

ret = SapModel.DesignColdFormed.SetCode("Eurocode 
 3 1-3 2006")

'run analysis

ret = SapModel.File.Save("C:\SapAPI\x.sdb")

ret = SapModel.Analyze.RunAnalysis

'start steel design

ret = SapModel.DesignColdFormed.StartDesign

'get overwrite item

ret = SapModel.DesignColdFormed.EuroCold06.GetOverwrite("8", 
 1, Value, ProgDet)

'close Sap2000

SapObject.ApplicationExit False

Set SapModel = Nothing

Set SapObject = Nothing

End Sub

Release Notes

Initial release in version 23.0.0.

Added item 34 in version 23.4.0

Changed references from major and minor axes to y-y 
 and z-z in version 23.4.0.

See Also

SetOverwrite