GetElm Method

cLinkObj GetElm Method

CSi API ETABS 2015

Retrieves the name of the link element (analysis model link) associated with a specified link object in the object-based model.

Namespace: ETABS2015
Assembly: ETABS2015 (in ETABS2015.dll) Version: 15.0.0.0 (15.0.0.0)

Syntax

C++

Copy to Clipboard Print

int GetElm(
	string Name,
	ref string Elm
)

int GetElm(
	string Name,
	ref string Elm
)

Function GetElm ( _
	Name As String, _
	ByRef Elm As String _
) As Integer

Function GetElm ( _
	Name As String, _
	ByRef Elm As String _
) As Integer

int GetElm(
	String^ Name, 
	String^% Elm
)

int GetElm(
	String^ Name, 
	String^% Elm
)

Parameters

Name: Type: System String
The name of an existing link object.

Elm: Type: System String

Return Value

Returns zero if the link element name is successfully retrieved; otherwise it returns nonzero. An error occurs if the analysis model does not exist.

Remarks

Examples

C++

Copy to Clipboard Print

Public Sub Example()
       Dim SapModel As cSapModel
       Dim EtabsObject As cOAPI
       Dim ret As Integer = -1 
       Dim Name As String 
       Dim Elm As String 

   '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)

   'create the analysis model
       ret = SapModel.Analyze.CreateAnalysisModel

   'get link element name
       ret = SapModel.LinkObj.GetElm(Name, Elm)

   'close ETABS
       EtabsObject.ApplicationExit(False)

   'clean up variables
       SapModel = Nothing
       EtabsObject = Nothing 
   End Sub

Public Sub Example()
       Dim SapModel As cSapModel
       Dim EtabsObject As cOAPI
       Dim ret As Integer = -1 
       Dim Name As String 
       Dim Elm As String 

   '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)

   'create the analysis model
       ret = SapModel.Analyze.CreateAnalysisModel

   'get link element name
       ret = SapModel.LinkObj.GetElm(Name, Elm)

   'close ETABS
       EtabsObject.ApplicationExit(False)

   'clean up variables
       SapModel = Nothing
       EtabsObject = Nothing 
   End Sub