SetGeneral Method

cPropFrame SetGeneral Method

CSi API ETABS 2015

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: ETABS2015
Assembly: ETABS2015 (in ETABS2015.dll) Version: 15.0.0.0 (15.0.0.0)

Syntax

C++

Copy to Clipboard Print

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 = ""
)

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 = ""
)

Function SetGeneral ( _
	Name As String, _
	MatProp As String, _
	T3 As Double, _
	T2 As Double, _
	Area As Double, _
	As2 As Double, _
	As3 As Double, _
	Torsion As Double, _
	I22 As Double, _
	I33 As Double, _
	S22 As Double, _
	S33 As Double, _
	Z22 As Double, _
	Z33 As Double, _
	R22 As Double, _
	R33 As Double, _
	Optional Color As Integer = -1, _
	Optional Notes As String = "", _
	Optional GUID As String = "" _
) As Integer

Function SetGeneral ( _
	Name As String, _
	MatProp As String, _
	T3 As Double, _
	T2 As Double, _
	Area As Double, _
	As2 As Double, _
	As3 As Double, _
	Torsion As Double, _
	I22 As Double, _
	I33 As Double, _
	S22 As Double, _
	S33 As Double, _
	Z22 As Double, _
	Z33 As Double, _
	R22 As Double, _
	R33 As Double, _
	Optional Color As Integer = -1, _
	Optional Notes As String = "", _
	Optional GUID As String = "" _
) As Integer

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 = L"", 
	String^ GUID = L""
)

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 = L"", 
	String^ GUID = L""
)

Parameters

Name: Type: System String
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: System String
The name of the material property for the section.

T3: Type: System Double

T2: Type: System Double

Area: Type: System Double
The cross-sectional area. [L2]

As2: Type: System Double
The shear area for forces in the section local 2-axis direction. [L2]

As3: Type: System Double
The shear area for forces in the section local 3-axis direction. [L2]

Torsion: Type: System Double
The torsional constant. [L4]

I22: Type: System Double
The moment of inertia for bending about the local 2 axis. [L4]

I33: Type: System Double
The moment of inertia for bending about the local 3 axis. [L4]

S22: Type: System Double
The section modulus for bending about the local 2 axis. [L3]

S33: Type: System Double
The section modulus for bending about the local 3 axis. [L3]

Z22: Type: System Double
The plastic modulus for bending about the local 2 axis. [L3]

Z33: Type: System Double
The plastic modulus for bending about the local 3 axis. [L3]

R22: Type: System Double
The radius of gyration about the local 2 axis. [L]

R33: Type: System Double
The radius of gyration about the local 3 axis. [L]

Color (Optional): Type: System Int32

Notes (Optional): Type: System String

GUID (Optional): Type: System String
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

Returns zero if the section property is successfully initialized; otherwise it returns a nonzero value.

Remarks

Examples

C++

Copy to Clipboard Print

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

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