Retrieves the pier label assignments of a frame object
Namespace: ETABS2015Assembly: ETABS2015 (in ETABS2015.dll) Version: 15.0.0.0 (15.0.0.0)
int GetPier(
string Name,
ref string PierName
)
Function GetPier ( _
Name As String, _
ByRef PierName As String _
) As Integer
int GetPier(
String^ Name,
String^% PierName
)
Parameters
- Name
- Type:
System String
The name of an existing frame object
- PierName
- Type: System String
The name of the pier assignment, if any, or "None"
Return Value
Returns zero if the assignment 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 PierName 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.PierLabel.SetPier("MyPier")
ret = SapModel.FrameObj.SetPier("3", "MyPier")
ret = SapModel.FrameObj.GetPier("3", PierName)
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 PierName 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)
'define new pier label
ret = SapModel.PierLabel.SetPier("MyPier")
'set assignment
ret = SapModel.FrameObj.SetPier("3", "MyPier")
'get assignment
ret = SapModel.FrameObj.GetPier("3", PierName)
'close ETABS
EtabsObject.ApplicationExit(False)
'clean up variables
SapModel = Nothing
EtabsObject = Nothing
End Sub