cFrameObjGetPier Method

Retrieves the pier label assignments of a frame object

Namespace:  ETABS2016
Assembly:  ETABS2016 (in ETABS2016.dll) Version: 16.0.0.0 (16.0.0.0)
Syntax
Copy
int GetPier(
	string Name,
	ref string PierName
)

Parameters

Name
Type: SystemString
The name of an existing frame object
PierName
Type: SystemString
The name of the pier assignment, if any, or "None"

Return Value

Type: Int32
Returns zero if the assignment is successfully retrieved; otherwise it returns a nonzero value.
Remarks
Examples
VB
Copy
Public 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
See Also