GetTube Method

cPropFrame GetTube Method

CSi API ETABS 2015

Retrieves frame section property data for a tube-type frame section.

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

Syntax

int GetTube(
	string Name,
	ref string FileName,
	ref string MatProp,
	ref double T3,
	ref double T2,
	ref double Tf,
	ref double Tw,
	ref int Color,
	ref string Notes,
	ref string GUID
)

int GetTube(
	string Name,
	ref string FileName,
	ref string MatProp,
	ref double T3,
	ref double T2,
	ref double Tf,
	ref double Tw,
	ref int Color,
	ref string Notes,
	ref string GUID
)

Function GetTube ( _
	Name As String, _
	ByRef FileName As String, _
	ByRef MatProp As String, _
	ByRef T3 As Double, _
	ByRef T2 As Double, _
	ByRef Tf As Double, _
	ByRef Tw As Double, _
	ByRef Color As Integer, _
	ByRef Notes As String, _
	ByRef GUID As String _
) As Integer

Function GetTube ( _
	Name As String, _
	ByRef FileName As String, _
	ByRef MatProp As String, _
	ByRef T3 As Double, _
	ByRef T2 As Double, _
	ByRef Tf As Double, _
	ByRef Tw As Double, _
	ByRef Color As Integer, _
	ByRef Notes As String, _
	ByRef GUID As String _
) As Integer

int GetTube(
	String^ Name, 
	String^% FileName, 
	String^% MatProp, 
	double% T3, 
	double% T2, 
	double% Tf, 
	double% Tw, 
	int% Color, 
	String^% Notes, 
	String^% GUID
)

int GetTube(
	String^ Name, 
	String^% FileName, 
	String^% MatProp, 
	double% T3, 
	double% T2, 
	double% Tf, 
	double% Tw, 
	int% Color, 
	String^% Notes, 
	String^% GUID
)

Parameters

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

FileName: Type: System String
If the section property was imported from a property file, this is the name of that file. If the section property was not imported, this item is blank.

MatProp: Type: System String
The name of the material property for the section.

T3: Type: System Double

T2: Type: System Double

Tf: Type: System Double

Tw: Type: System Double

Color: Type: System Int32

Notes: Type: System String

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

Return Value

Returns zero if the section 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 

   '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 frame section property
       ret = SapModel.PropFrame.SetTube("TUBE1", "A992Fy50", 8, 6, 0.5, 0.5)

   '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 

   '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 frame section property
       ret = SapModel.PropFrame.SetTube("TUBE1", "A992Fy50", 8, 6, 0.5, 0.5)

   'close ETABS
       EtabsObject.ApplicationExit(False)

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