GetLoadForce

Syntax

SapObject.SapModel.PointObj.GetLoadForce

VB6 Procedure

Function GetLoadForce(ByVal Name As String, ByRef NumberItems As Long, ByRef PointName() As String, ByRef LoadCase() As String, ByRef LCStep() As Long, ByRef CSys() As String, ByRef F1() As Double, ByRef F2() As Double, ByRef F3() As Double, ByRef M1() As Double, ByRef M2() As Double, ByRef M3() As Double, Optional ByVal ItemType As eItemType = Object) As Long

Parameters

Name

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

NumberItems

This is the total number of joint force load assignments returned.

PointName

This is an array that includes the name of the point object to which the specified load assignment applies.

LoadCase

This is an array that includes the name of the load case for the load.

LCStep

This is an array that includes the load case step for the load. In most cases, this item does not apply and will be returned as 0.

CSys

This is an array that includes the name of the coordinate system for the load. This is Local or the name of a defined coordinate system.

This is an array that includes the assigned translational force in the local 1-axis or coordinate system X-axis direction, depending on the specified CSys. [F]

This is an array that includes the assigned translational force in the local 2-axis or coordinate system Y-axis direction, depending on the specified CSys. [F]

This is an array that includes the assigned translational force in the local 3-axis or coordinate system Z-axis direction, depending on the specified CSys. [F]

This is an array that includes the assigned moment about the local 1-axis or coordinate system X-axis, depending on the specified CSys. [FL]

This is an array that includes the assigned moment about the local 2-axis or coordinate system Y-axis, depending on the specified CSys. [FL]

This is an array that includes the assigned moment about the local 3-axis or coordinate system Z-axis, depending on the specified CSys. [FL]

ItemType

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

Object = 0

Group = 1

SelectedObjects = 2

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

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

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

Remarks

This function retrieves the joint force load assignments to point objects.

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

VBA Example

Sub GetPointForceLoad()
   'dimension variables
      Dim SapObject As Sap2000.SapObject
      Dim SapModel As cSapModel
      Dim ret As Long
      Dim NumberItems As Long
      Dim PointName() As String
      Dim LoadCase() As String
      Dim LCStep() As Long
      Dim CSys() As String
      Dim F1() As Double
      Dim F2() As Double
      Dim F3() As Double
      Dim M1() As Double
      Dim M2() As Double
      Dim M3() As Double
      Dim Value() As Double

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

   'add joint force load
      Redim Value(5)
      Value(0) = 10
      ret = SapModel.PointObj.SetLoadForce("1", "DEAD", Value)

   'get joint force load
      ret = SapModel.PointObj.GetLoadForce("ALL", NumberItems, PointName, LoadCase, LCStep, CSys, F1, F2, F3, M1, M2, M3, Group)

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

Release Notes

Initial release in version 11.00.