GetTC Limits {Frame Object}

GetTCLimits

Syntax

SapObject.SapModel.FrameObj.GetTCLimits

VB6 Procedure

Function GetTCLimits(ByVal Name As String, ByRef LimitCompressionExists As Boolean, ByRef LimitCompression As Double, ByRef LimitTensionExists As Boolean, ByRef LimitTension As Double) As Long

Parameters

Name

The name of an existing frame object.

LimitCompressionExists

This item is True if a compression force limit exists for the frame object.

LimitCompression

The compression force limit for the frame object. [F]

LimitTensionExists

This item is True if a tension force limit exists for the frame object.

LimitTension

The tension force limit for the frame object. [F]

Remarks

This function retrieves the tension/compression force limit assignments to frame objects.

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

Note that the tension and compression limits are used only in nonlinear analyses.

VBA Example

Sub GetFrameTCLimits()

'dimension variables

Dim SapObject as cOAPI

Dim SapModel As cSapModel

Dim ret As Long

Dim LimitCompressionExists As Boolean

Dim LimitCompression As Double

Dim LimitTensionExists As Boolean

Dim LimitTension 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 tension/compression limits

ret = SapModel.FrameObj.SetTCLimits("1", False, 0, True, 100)

'get tension/compression limits

ret = SapModel.FrameObj.GetTCLimits("1", LimitCompressionExists, LimitCompression, LimitTensionExists, LimitTension)

'close Sap2000

SapObject.ApplicationExit False

Set SapModel = Nothing

Set SapObject = Nothing

End Sub

Release Notes

Initial release in version 11.00.

See Also

SetTCLimits