GetWallAutoSelectList Method

cPropArea GetWallAutoSelectList Method

CSi API ETABS 2015

Retrieves property data for an auto select list wall section.

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

Syntax

int GetWallAutoSelectList(
	string Name,
	ref string[] AutoSelectList,
	ref string StartingProperty
)

int GetWallAutoSelectList(
	string Name,
	ref string[] AutoSelectList,
	ref string StartingProperty
)

Function GetWallAutoSelectList ( _
	Name As String, _
	ByRef AutoSelectList As String(), _
	ByRef StartingProperty As String _
) As Integer

Function GetWallAutoSelectList ( _
	Name As String, _
	ByRef AutoSelectList As String(), _
	ByRef StartingProperty As String _
) As Integer

int GetWallAutoSelectList(
	String^ Name, 
	array<String^>^% AutoSelectList, 
	String^% StartingProperty
)

int GetWallAutoSelectList(
	String^ Name, 
	array<String^>^% AutoSelectList, 
	String^% StartingProperty
)

Parameters

Name: Type: System String
The name of an existing auto select list wall property.

AutoSelectList: Type: System String
This is an array of the names of the wall properties included in the auto select list.

StartingProperty: Type: System String
This is Median or the name of a wall property in the AutoSelectList array. It is the starting section for the auto select list.
Median indicates the Median Property by Thickness

Return Value

The function returns zero if the property data is successfully retrieved; otherwise it returns a nonzero value.

Remarks

Examples

C++

Copy to Clipboard Print

Public Sub Example()
       Dim SapModel As cSapModel
       Dim EtabsObject As cOAPI
       Dim ret As Integer = -1 
       Dim WallPropType As ETABS2013.eWallPropType
       Dim ShellType As ETABS2013.eShellType
       Dim MatProp As String 
       Dim Thickness As Double 
       Dim Color As Integer 
       Dim Notes As String 
       Dim GUID As String 
       Dim AutoSelectList As String()
       Dim StartingProp 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)

   'set new area property
       ret = SapModel.PropArea.SetWall("MyShellProp1A", ETABS2013.eWallPropType.Specified, ETABS2013.eShellType.ShellThick, "4000Psi", 11.1)

   'set new area property
       ret = SapModel.PropArea.SetWall("MyShellProp1B", ETABS2013.eWallPropType.Specified, ETABS2013.eShellType.ShellThin, "4000Psi", 12.2)

   'set new area property
       ret = SapModel.PropArea.SetWall("MyShellProp1C", ETABS2013.eWallPropType.AutoSelectList, ETABS2013.eShellType.ShellThick, "4000Psi", 13.3)

   'set new area property
       ret = SapModel.PropArea.SetWall("MyShellProp1D", ETABS2013.eWallPropType.AutoSelectList, ETABS2013.eShellType.ShellThick, "4000Psi", 14.4)

   'set new area property 
       Dim tmpList As String()
       ReDim tmpList(2)
       tmpList(0) = "MyShellProp1A"
       tmpList(1) = "MyShellProp1B"
       tmpList(2) = "MyShellProp1C"
       ret = SapModel.PropArea.SetWallAutoSelectList("MyShellProp1D", tmpList, "MyShellProp1B")

   'get area property data
       ret = SapModel.PropArea.GetWall("MyShellProp1D", WallPropType, ShellType, MatProp, Thickness, Color, Notes, GUID)

   'get area property data
       ret = SapModel.PropArea.GetWallAutoSelectList("MyShellProp1D", AutoSelectList, StartingProp)

   '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 WallPropType As ETABS2013.eWallPropType
       Dim ShellType As ETABS2013.eShellType
       Dim MatProp As String 
       Dim Thickness As Double 
       Dim Color As Integer 
       Dim Notes As String 
       Dim GUID As String 
       Dim AutoSelectList As String()
       Dim StartingProp 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)

   'set new area property
       ret = SapModel.PropArea.SetWall("MyShellProp1A", ETABS2013.eWallPropType.Specified, ETABS2013.eShellType.ShellThick, "4000Psi", 11.1)

   'set new area property
       ret = SapModel.PropArea.SetWall("MyShellProp1B", ETABS2013.eWallPropType.Specified, ETABS2013.eShellType.ShellThin, "4000Psi", 12.2)

   'set new area property
       ret = SapModel.PropArea.SetWall("MyShellProp1C", ETABS2013.eWallPropType.AutoSelectList, ETABS2013.eShellType.ShellThick, "4000Psi", 13.3)

   'set new area property
       ret = SapModel.PropArea.SetWall("MyShellProp1D", ETABS2013.eWallPropType.AutoSelectList, ETABS2013.eShellType.ShellThick, "4000Psi", 14.4)

   'set new area property 
       Dim tmpList As String()
       ReDim tmpList(2)
       tmpList(0) = "MyShellProp1A"
       tmpList(1) = "MyShellProp1B"
       tmpList(2) = "MyShellProp1C"
       ret = SapModel.PropArea.SetWallAutoSelectList("MyShellProp1D", tmpList, "MyShellProp1B")

   'get area property data
       ret = SapModel.PropArea.GetWall("MyShellProp1D", WallPropType, ShellType, MatProp, Thickness, Color, Notes, GUID)

   'get area property data
       ret = SapModel.PropArea.GetWallAutoSelectList("MyShellProp1D", AutoSelectList, StartingProp)

   'close ETABS
       EtabsObject.ApplicationExit(False)

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