SetGroupAssign

Syntax

SapObject.SapModel.CableObj.SetGroupAssign

VB6 Procedure

Function SetGroupAssign(ByVal Name As String, ByVal GroupName As String, Optional Remove As Boolean = False, Optional ByVal ItemType As eItemType = Object) As Long

Parameters

Name

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

GroupName

The name of an existing group to which the assignment is made.

Remove

If this item is False, the specified cable objects are added to the group specified by the GroupName item. If it is True, the cable objects are removed from the group.

ItemType

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

Object = 0

Group = 1

SelectedObjects = 2

If this item is Object, the cable object specified by the Name item is added or removed from the group specified by the GroupName item.

If this item is Group, all cable objects in the group specified by the Name item are added or removed from the group specified by the GroupName item.

If this item is SelectedObjects, all selected cable objects are added or removed from the group specified by the GroupName item, and the Name item is ignored.

Remarks

This function adds or removes cable objects from a specified group.

The function returns zero if the group assignment is successful, otherwise it returns a nonzero value.

VBA Example

Sub AddCableObjectsToGroup()
   'dimension variables
      Dim SapObject As Sap2000.SapObject
      Dim SapModel As cSapModel
      Dim ret As Long
      Dim Name1 As String
      Dim Name2 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, 3, 124, 3, 200)

   'add cable object by points
      ret = SapModel.CableObj.AddByPoint("1", "6", Name1)
      ret = SapModel.CableObj.AddByPoint("5", "10", Name2)

   'set cable data
      ret = SapModel.CableObj.SetCableData(Name1, 7, 1, 0, 0, 24)
      ret = SapModel.CableObj.SetCableData(Name2, 7, 1, 0, 0, 24)

   'define new group
      ret = SapModel.GroupDef.SetGroup("Group1")

   'add cable objects to group
      ret = SapModel.CableObj.SetGroupAssign(Name1, "Group1")
      ret = SapModel.CableObj.SetGroupAssign(Name2, "Group1")

   'select objects in group
      ret = SapModel.SelectObj.Group("Group1")

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

Release Notes

Initial release in version 11.00.