cFrameObjGetColumnSpliceOverwrite Method

Retrieves the frame object column splice overwrite assignment.

Namespace:  ETABS2016
Assembly:  ETABS2016 (in ETABS2016.dll) Version: 16.0.0.0 (16.0.0.0)
Syntax
Copy
int GetColumnSpliceOverwrite(
	string Name,
	ref int SpliceOption,
	ref double Height
)

Parameters

Name
Type: SystemString
The name of an existing frame object.
SpliceOption
Type: SystemInt32
This is a numeric value from 1 to 3 that specifies the option used for defining the splice overwrite.
  1. from story data (default)
  2. no splice
  3. splice at height above story at bottom of the column object
Height
Type: SystemDouble
If the SpliceOption=3, this specifies the height of the splice above the story at the bottom of the column object.

Return Value

Type: Int32
Returns zero if the column splice overwrite data 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

'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)

'assign column splice overwrite
   ret = SapModel.FrameObj.SetColumnSpliceOverwrite("15", 2, 0)

'get column splice overwrite
   Dim SpliceOption As Integer
   Dim Height As Double
   ret = SapModel.FrameObj.GetColumnSpliceOverwrite("15", SpliceOption, Height)

'close ETABS
   EtabsObject.ApplicationExit(False)

'clean up variables
   SapModel = Nothing
   EtabsObject = Nothing

End Sub
See Also