cFrameObjSetPier Method

Sets the pier label assignment of one or more frame objects

Namespace:  ETABS2016
Assembly:  ETABS2016 (in ETABS2016.dll) Version: 16.0.0.0 (16.0.0.0)
Syntax
Copy
int SetPier(
	string Name,
	string PierName,
	eItemType ItemType = eItemType.Objects
)

Parameters

Name
Type: SystemString
The name of an existing frame object or group, depending on the value of the ItemType item.
PierName
Type: SystemString
The name of the pier assignment, or "None", to unset any assignment
ItemType (Optional)
Type: ETABS2016eItemType
This is one of the following items in the eItemType enumeration:
  • Object = 0
  • Group = 1
  • SelectedObjects = 2

If this item is Objects, the assignment is made to the frame object specified by the Name item.

If this item is Group, the assignment is made to all frame objects in the group specified by the Name item.

If this item is SelectedObjects, assignment is made to all selected frame objects, and the Name item is ignored.

Return Value

Type: Int32
Returns zero if the assignment is successful; 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