cAreaObjGetLabelFromName Method

Retrieves the label and story for a unique area object name

Namespace:  ETABS2016
Assembly:  ETABS2016 (in ETABS2016.dll) Version: 16.0.0.0 (16.0.0.0)
Syntax
Copy
int GetLabelFromName(
	string Name,
	ref string Label,
	ref string Story
)

Parameters

Name
Type: SystemString
The name of the area object
Label
Type: SystemString
The area object label
Story
Type: SystemString
The area object story level

Return Value

Type: Int32
Returns zero if the data is successfully retrieved, otherwise it returns nonzero.
Remarks
Examples
VB
Copy
Public Sub Example()
   Dim SapModel As cSapModel
   Dim EtabsObject As cOAPI
   Dim ret As Integer = -1
   Dim NumberNames As Integer
   Dim Label As String
   Dim Story 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)

'get area object data
   ret = SapModel.AreaObj.GetLabelFromName("3", Label, Story)

'close ETABS
   EtabsObject.ApplicationExit(False)

'clean up variables
   SapModel = Nothing
   EtabsObject = Nothing

End Sub
See Also