Retrieves the selected status for a link object.
Namespace: ETABS2015Assembly: ETABS2015 (in ETABS2015.dll) Version: 15.0.0.0 (15.0.0.0)
int GetSelected(
string Name,
ref bool Selected
)
Function GetSelected ( _
Name As String, _
ByRef Selected As Boolean _
) As Integer
int GetSelected(
String^ Name,
bool% Selected
)
Parameters
- Name
- Type:
System String
The name of an existing link object.
- Selected
- Type: System Boolean
This item is True if the specified link object is selected;
otherwise it is False.
Return Value
Returns zero if the selected status is successfully retrieved;
otherwise it returns a nonzero value.
Public Sub Example()
Dim SapModel As cSapModel
Dim EtabsObject As cOAPI
Dim ret As Integer = -1
Dim Name As String
Dim Selected As Boolean
EtabsObject = CreateObject("CSI.ETABS.API.ETABSObject")
ret = EtabsObject.ApplicationStart()
SapModel = EtabsObject.SapModel
ret = SapModel.InitializeNewModel()
ret = SapModel.File.NewSteelDeck(4,12,12,4,4,24,24)
ret = SapModel.LinkObj.AddByPoint("1", "5", Name)
ret = SapModel.LinkObj.SetSelected("ALL", True, ETABS2013.eItemType.Group)
ret = SapModel.LinkObj.GetSelected(Name, Selected)
EtabsObject.ApplicationExit(False)
SapModel = Nothing
EtabsObject = Nothing
End SubPublic Sub Example()
Dim SapModel As cSapModel
Dim EtabsObject As cOAPI
Dim ret As Integer = -1
Dim Name As String
Dim Selected As Boolean
'create ETABS object
EtabsObject = CreateObject("CSI.ETABS.API.ETABSObject")
'start ETABS application
ret = EtabsObject.ApplicationStart()
'create SapModel object
SapModel = EtabsObject.SapModel
'initialize model
ret = SapModel.InitializeNewModel()
'create steel deck template model
ret = SapModel.File.NewSteelDeck(4,12,12,4,4,24,24)
'add link object by points
ret = SapModel.LinkObj.AddByPoint("1", "5", Name)
'set link object selected
ret = SapModel.LinkObj.SetSelected("ALL", True, ETABS2013.eItemType.Group)
'get link object selected status
ret = SapModel.LinkObj.GetSelected(Name, Selected)
'close ETABS
EtabsObject.ApplicationExit(False)
'clean up variables
SapModel = Nothing
EtabsObject = Nothing
End Sub