Retrieves frame section property data for a pipe-type frame section.
Namespace: ETABS2015Assembly: ETABS2015 (in ETABS2015.dll) Version: 15.0.0.0 (15.0.0.0)
int GetPipe(
string Name,
ref string FileName,
ref string MatProp,
ref double T3,
ref double TW,
ref int Color,
ref string Notes,
ref string GUID
)
Function GetPipe ( _
Name As String, _
ByRef FileName As String, _
ByRef MatProp As String, _
ByRef T3 As Double, _
ByRef TW As Double, _
ByRef Color As Integer, _
ByRef Notes As String, _
ByRef GUID As String _
) As Integer
int GetPipe(
String^ Name,
String^% FileName,
String^% MatProp,
double% T3,
double% TW,
int% Color,
String^% Notes,
String^% GUID
)
Parameters
- Name
- Type:
System String
The name of an existing frame section.
- 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
- TW
- Type: System Double
The wall thickness. [L]
- 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.
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 tw As Double
Dim Color As Integer
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.SetPipe("PIPE1", "A992Fy50", 8, 0.375)
ret = SapModel.PropFrame.GetPipe("PIPE1", FileName, MatProp, t3, 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 tw 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 frame section property
ret = SapModel.PropFrame.SetPipe("PIPE1", "A992Fy50", 8, 0.375)
'get frame section property data
ret = SapModel.PropFrame.GetPipe("PIPE1", FileName, MatProp, t3, tw, Color, Notes, GUID)
'close ETABS
EtabsObject.ApplicationExit(False)
'clean up variables
SapModel = Nothing
EtabsObject = Nothing
End Sub