cPropFrameGetTypeOAPI Method

Retrieves the property type for the specified frame section property.

Namespace:  ETABS2016
Assembly:  ETABS2016 (in ETABS2016.dll) Version: 16.0.0.0 (16.0.0.0)
Syntax
Copy
int GetTypeOAPI(
	string Name,
	ref eFramePropType PropType
)

Parameters

Name
Type: SystemString
The name of an existing frame section property.
PropType
Type: ETABS2016eFramePropType
This is one of the items in the eFramePropType enumeration.

Return Value

Type: Int32
Returns zero if the type is successfully retrieved; otherwise it returns nonzero.
Remarks
Examples
VB
Copy
Public Sub Example()
       Dim SapModel As cSapModel
       Dim EtabsObject As cOAPI
       Dim ret As Integer = -1
       Dim PropType As eFramePropType

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

   'get frame property type
       ret = SapModel.PropFrame.GetTypeOAPI("FSEC1", PropType)

   'close ETABS
       EtabsObject.ApplicationExit(False)

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