SetSelected

Syntax

Sap2000.CableObj.SetSelected

VB6 Procedure

Function SetSelected(ByVal Name As String, ByVal Selected As Boolean, 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.

Selected

This item is True if the specified cable object is selected, otherwise it is False.

ItemType

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

Object = 0

Group = 1

SelectedObjects = 2

If this item is Object, the selected status is set for the cable object specified by the Name item.

If this item is Group, the selected status is set for all cable objects in the group specified by the Name item.

If this item is SelectedObjects, the selected status is set for all selected cable objects, and the Name item is ignored.

Remarks

This function sets the selected status for a cable object.

The function returns zero if the selected status is successfully set, otherwise it returns a nonzero value.

VBA Example

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

   'add cable object by points
      ret = SapModel.CableObj.AddByPoint("1", "6", Name)

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

   'set cable object selected
      ret = SapModel.CableObj.SetSelected(Name, True)

   'update view
      ret = SapModel.View.RefreshView

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

Release Notes

Initial release in version 11.00.