cSpandrelLabelGetNameList Method

Retrieves the names of all defined Spandrel Labels

Namespace:  ETABS2016
Assembly:  ETABS2016 (in ETABS2016.dll) Version: 16.0.0.0 (16.0.0.0)
Syntax
Copy
int GetNameList(
	ref int NumberNames,
	ref string[] MyName,
	ref bool[] IsMultiStory
)

Parameters

NumberNames
Type: SystemInt32
The number of Spandrel Labels defined in the program
MyName
Type: SystemString
This is a one-dimensional array of coordinate system names. The MyName array is created as a dynamic, zero-based, array by the API user:

Dim MyName() as String

The array is dimensioned to (NumberNames – 1) inside the ETABS program, filled with the names, and returned to the API user.

IsMultiStory
Type: SystemBoolean
This values of this array are True or False, indicating whether the associated Spandrel Label spans multiple story levels

Return Value

Type: Int32
Returns zero if the names are 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 MyName As String()
   Dim IsMultiStory 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)

'define new Spandrel label
    ret = SapModel.SpandrelLabel.SetSpandrel("MySpandrel", False)

'get names
    ret = SapModel.SpandrelLabel.GetNameList(NumberNames, MyName)

'close ETABS
   EtabsObject.ApplicationExit(False)

'clean up variables
   SapModel = Nothing
   EtabsObject = Nothing

End Sub
See Also