cPropFrameSetGeneral Method

Initializes a general frame section property. If this function is called for an existing frame section property, all items for the section are reset to their default value.

Namespace:  ETABS2016
Assembly:  ETABS2016 (in ETABS2016.dll) Version: 16.0.0.0 (16.0.0.0)
Syntax
Copy
int SetGeneral(
	string Name,
	string MatProp,
	double T3,
	double T2,
	double Area,
	double As2,
	double As3,
	double Torsion,
	double I22,
	double I33,
	double S22,
	double S33,
	double Z22,
	double Z33,
	double R22,
	double R33,
	int Color = -1,
	string Notes = "",
	string GUID = ""
)

Parameters

Name
Type: SystemString
The name of an existing or new frame section property. If this is an existing property, that property is modified; otherwise, a new property is added.
MatProp
Type: SystemString
The name of the material property for the section.
T3
Type: SystemDouble
T2
Type: SystemDouble
Area
Type: SystemDouble
The cross-sectional area. [L2]
As2
Type: SystemDouble
The shear area for forces in the section local 2-axis direction. [L2]
As3
Type: SystemDouble
The shear area for forces in the section local 3-axis direction. [L2]
Torsion
Type: SystemDouble
The torsional constant. [L4]
I22
Type: SystemDouble
The moment of inertia for bending about the local 2 axis. [L4]
I33
Type: SystemDouble
The moment of inertia for bending about the local 3 axis. [L4]
S22
Type: SystemDouble
The section modulus for bending about the local 2 axis. [L3]
S33
Type: SystemDouble
The section modulus for bending about the local 3 axis. [L3]
Z22
Type: SystemDouble
The plastic modulus for bending about the local 2 axis. [L3]
Z33
Type: SystemDouble
The plastic modulus for bending about the local 3 axis. [L3]
R22
Type: SystemDouble
The radius of gyration about the local 2 axis. [L]
R33
Type: SystemDouble
The radius of gyration about the local 3 axis. [L]
Color (Optional)
Type: SystemInt32
Notes (Optional)
Type: SystemString
GUID (Optional)
Type: SystemString
The GUID (global unique identifier), if any, assigned to the section. If this item is input as Default, the program assigns a GUID to the section.

Return Value

Type: Int32
Returns zero if the section property is successfully initialized; 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)

   'set new frame section property
       ret = SapModel.PropFrame.SetGeneral("GEN1", "A992Fy50", 24, 14, 100, 80, 80, 4, 1000, 2400, 140, 200, 150, 220, 3, 5, -1, "API example", "Default")

   'close ETABS
       EtabsObject.ApplicationExit(False)

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