SetLoadedGroup

Syntax

SapObject.SapModel.TendonObj.SetLoadedGroup

VB6 Procedure

Function SetLoadedGroup(ByVal Name As String, ByVal GroupName As String, 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.

GroupName

This is the name of an existing group. All objects in the specified group can be loaded by the tendon.

ItemType

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

Object = 0

Group = 1

SelectedObjects = 2

If this item is Object, the assignment is made to the tendon object specified by the Name item.

If this item is Group, the assignment is made to all tendon objects in the group specified by the Name item.

If this item is SelectedObjects, assignment is made to all selected tendon objects, and the Name item is ignored.

Remarks

This function makes the loaded group assignment to tendon objects. A tendon object transfers its load to any object that is in the specified group.

The function returns zero if the group is successfully assigned, otherwise it returns a nonzero value.

VBA Example

Sub AssignTendonLoadedGroup()
   'dimension variables
      Dim SapObject As Sap2000.SapObject
      Dim SapModel As cSapModel
      Dim ret As Long
      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 loaded group
      ret = SapModel.TendonObj.SetLoadedGroup(Name, "ALL")

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

Release Notes

Initial release in version 11.00.