Initializes a tube-type frame section property.
If this function is called for an existing frame section property,
all items for the section are reset to their default value.
Namespace: ETABS2015Assembly: ETABS2015 (in ETABS2015.dll) Version: 15.0.0.0 (15.0.0.0)
int SetTube(
string Name,
string MatProp,
double T3,
double T2,
double Tf,
double Tw,
int Color = -1,
string Notes = "",
string GUID = ""
)
Function SetTube ( _
Name As String, _
MatProp As String, _
T3 As Double, _
T2 As Double, _
Tf As Double, _
Tw As Double, _
Optional Color As Integer = -1, _
Optional Notes As String = "", _
Optional GUID As String = "" _
) As Integer
int SetTube(
String^ Name,
String^ MatProp,
double T3,
double T2,
double Tf,
double Tw,
int Color = -1,
String^ Notes = L"",
String^ GUID = L""
)
Parameters
- Name
- Type:
System String
The name of an existing or new frame section property.
If this is an existing property, that property is modified;
otherwise, a new property is added.
- 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 (Optional)
- Type: System Int32
- Notes (Optional)
- Type: System String
- GUID (Optional)
- Type: System String
The GUID (global unique identifier), if any, assigned to the section.
If this item is input as Default, the program assigns a GUID to the section.
Return Value
Returns zero if the section property is successfully initialized; otherwise it returns a nonzero value.
Public Sub Example()
Dim SapModel As cSapModel
Dim EtabsObject As cOAPI
Dim ret As Integer = -1
Dim FileName As String
Dim MatProp As String
Dim t3 As Double
Dim t2 As Double
Dim tf As Double
Dim tw As Double
Dim Color As Long
Dim Notes As String
Dim GUID As String
EtabsObject = CreateObject("CSI.ETABS.API.ETABSObject")
ret = EtabsObject.ApplicationStart()
SapModel = EtabsObject.SapModel
ret = SapModel.InitializeNewModel()
ret = SapModel.File.NewSteelDeck(4,12,12,4,4,24,24)
ret = SapModel.PropFrame.SetTube("TUBE1", "A992Fy50", 8, 6, 0.5, 0.5)
ret = SapModel.PropFrame.GetTube("TUBE1", FileName, MatProp, t3, t2, tf, tw, Color, Notes, GUID)
EtabsObject.ApplicationExit(False)
SapModel = Nothing
EtabsObject = Nothing
End SubPublic Sub Example()
Dim SapModel As cSapModel
Dim EtabsObject As cOAPI
Dim ret As Integer = -1
Dim FileName As String
Dim MatProp As String
Dim t3 As Double
Dim t2 As Double
Dim tf As Double
Dim tw As Double
Dim Color As Long
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 frame section property
ret = SapModel.PropFrame.SetTube("TUBE1", "A992Fy50", 8, 6, 0.5, 0.5)
'get frame section property data
ret = SapModel.PropFrame.GetTube("TUBE1", FileName, MatProp, t3, t2, tf, tw, Color, Notes, GUID)
'close ETABS
EtabsObject.ApplicationExit(False)
'clean up variables
SapModel = Nothing
EtabsObject = Nothing
End Sub