GetLoadDeformation

Syntax

SapObject.SapModel.TendonObj.GetLoadDeformation

VB6 Procedure

Function GetLoadDeformation(ByVal Name As String, ByRef NumberItems As Long, ByRef TendonName() As String, ByRef LoadCase() As String, ByRef U1() As Double, Optional ByVal ItemType As eItemType = Object) As Long

Parameters

Name

The name of an existing tendon object or group, depending on the value of the ItemType item.

NumberItems

The total number of deformation loads retrieved for the specified tendon objects.

TendonName

This is an array that includes the name of the tendon object associated with each deformation load.

LoadCase

This is an array that includes the name of the load case associated with each deformation load.

This is an array of axial deformation load values. [L]

ItemType

This is one of the following items in the eItemType enumeration:

Object = 0

Group = 1

SelectedObjects = 2

If this item is Object, the assignments are retrieved for the tendon object specified by the Name item.

If this item is Group, the assignments are retrieved for all tendon objects in the group specified by the Name item.

If this item is SelectedObjects, assignments are retrieved for all selected tendon objects, and the Name item is ignored.

Remarks

This function retrieves the deformation load assignments to tendon objects.

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

VBA Example

Sub GetTendonDeformationLoad()
   'dimension variables
      Dim SapObject As Sap2000.SapObject
      Dim SapModel As cSapModel
      Dim ret As Long
      Dim NumberItems As Long
      Dim TendonName() As String
      Dim LoadCase() As String
      Dim U1() As Double
      Dim Name As String

   'create Sap2000 object
      Set SapObject = New SAP2000.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)

   'add tendon object by points
      ret = SapModel.TendonObj.AddByPoint("3", "9", Name)

   'assign tendon deformation loads
      ret = SapModel.TendonObj.SetLoadDeformation("ALL", "DEAD", 2, Group)

   'get tendon deformation loads
      ret = SapModel.TendonObj.GetLoadDeformation(Name, NumberItems, TendonName, LoadCase, U1)

   'close Sap2000
      SapObject.ApplicationExit False
      Set SapModel = Nothing
      Set SapObject = Nothing
End Sub

Release Notes

Initial release in version 11.00.