GetWall Method

cPropArea GetWall Method

CSi API ETABS 2015

Retrieves property data for a wall section.

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

Syntax

int GetWall(
	string Name,
	ref eWallPropType WallPropType,
	ref eShellType ShellType,
	ref string MatProp,
	ref double Thickness,
	ref int color,
	ref string notes,
	ref string GUID
)

int GetWall(
	string Name,
	ref eWallPropType WallPropType,
	ref eShellType ShellType,
	ref string MatProp,
	ref double Thickness,
	ref int color,
	ref string notes,
	ref string GUID
)

Function GetWall ( _
	Name As String, _
	ByRef WallPropType As eWallPropType, _
	ByRef ShellType As eShellType, _
	ByRef MatProp As String, _
	ByRef Thickness As Double, _
	ByRef color As Integer, _
	ByRef notes As String, _
	ByRef GUID As String _
) As Integer

Function GetWall ( _
	Name As String, _
	ByRef WallPropType As eWallPropType, _
	ByRef ShellType As eShellType, _
	ByRef MatProp As String, _
	ByRef Thickness As Double, _
	ByRef color As Integer, _
	ByRef notes As String, _
	ByRef GUID As String _
) As Integer

int GetWall(
	String^ Name, 
	eWallPropType% WallPropType, 
	eShellType% ShellType, 
	String^% MatProp, 
	double% Thickness, 
	int% color, 
	String^% notes, 
	String^% GUID
)

int GetWall(
	String^ Name, 
	eWallPropType% WallPropType, 
	eShellType% ShellType, 
	String^% MatProp, 
	double% Thickness, 
	int% color, 
	String^% notes, 
	String^% GUID
)

Parameters

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

WallPropType: Type: ETABS2015 eWallPropType
This is one of the items in the eWallPropType enumeration.
If this item is AutoSelectList, use the GetWallAutoSelectList(String, String , String ) function to get additional parameters.

ShellType: Type: ETABS2015 eShellType
This is one of the items in the eShellType enumeration.

MatProp: Type: System String
The name of the material property for the area property.
This item does not apply when ShellType is Layered.

Thickness: Type: System Double
The membrane thickness. [L]
This item does not apply when ShellType is Layered.

color: Type: System Int32
The display color assigned to the property.

notes: Type: System String
The notes, if any, assigned to the property.

GUID: Type: System String
The GUID (global unique identifier), if any, assigned to the property.

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 

   '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.ShellThin, "4000Psi", 14.2)

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

   '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 

   '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.ShellThin, "4000Psi", 14.2)

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

   'close ETABS
       EtabsObject.ApplicationExit(False)

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