cPropTendonGetProp Method

Retrieves tendon property definition data.

Namespace:  ETABS2016
Assembly:  ETABS2016 (in ETABS2016.dll) Version: 16.0.0.0 (16.0.0.0)
Syntax
Copy
int GetProp(
	string Name,
	ref string MatProp,
	ref int ModelingOption,
	ref double Area,
	ref int Color,
	ref string Notes,
	ref string GUID
)

Parameters

Name
Type: SystemString
The name of an existing tendon property.
MatProp
Type: SystemString
The name of the material property assigned to the tendon property.
ModelingOption
Type: SystemInt32
This is either 1 or 2, indicating the tendon modeling option.
ValueModeling Option
1Model tendon as loads
2Model tendon as elements
Area
Type: SystemDouble
The cross-sectional area of the tendon. [L2]
Color
Type: SystemInt32
Notes
Type: SystemString
GUID
Type: SystemString
The GUID (global unique identifier), if any, assigned to the property.

Return Value

Type: Int32
Returns zero if the property is successfully retrieved; otherwise it returns a nonzero value.
Remarks
Modeling tendons as elements (ModelingOption = 2) is not supported in ETABS.
Examples
VB
Copy
Public Sub Example()
       Dim SapModel As cSapModel
       Dim EtabsObject As cOAPI
       Dim ret As Integer = -1
       Dim Name As String
       Dim MatProp As String
       Dim ModelingOption As Integer
       Dim Area 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)

   'add tendon material
       ret = SapModel.PropMaterial.AddQuick(Name, eMatType.Tendon, , , , , , eMatTypeTendon.ASTM_A416Gr270)

   'set new tendon property
       ret = SapModel.PropTendon.SetProp("T1", Name, 1, 2.25)

   'get tendon property data
       ret = SapModel.PropTendon.GetProp("T1", MatProp, ModelingOption, Area, Color, Notes, GUID)

   'close ETABS
       EtabsObject.ApplicationExit(False)

   'clean up variables
       SapModel = Nothing
       EtabsObject = Nothing
   End Sub
See Also