GetProperty {Plane Element}

GetProperty

Syntax

SapObject.SapModel.PlaneElm.GetProperty

VB6 Procedure

Function GetProperty(ByVal Name As String, ByRef PropName As String) As Long

Parameters

Name

The name of a defined plane element.

PropName

The name of the area property assigned to the plane element. This item is None if there is no area property assigned to the plane element.

Remarks

This function retrieves the area property assigned to an plane element.

The function returns zero if the property is successfully retrieved; otherwise it returns a nonzero value.

VBA Example

Sub GetPlaneElementProp()

'dimension variables

Dim SapObject as cOAPI

Dim SapModel As cSapModel

Dim ret As Long

Dim PropName As String

'create Sap2000 object

Set SapObject = CreateObject("CSI.SAP2000.API.SapObject")

'start Sap2000 application

SapObject.ApplicationStart

'create SapModel object

Set SapModel = SapObject.SapModel

'initialize model

ret = SapModel.InitializeNewModel

'open existing model

ret = SapModel.File.OpenFile("C:\SapAPI\Example 3-001-incomp.sdb")

'create analysis model

ret = SapModel.Analyze.CreateAnalysisModel

'get area property for plane element

ret = SapModel.PlaneElm.GetProperty("1", PropName)

'close Sap2000

SapObject.ApplicationExit False

Set SapModel = Nothing

Set SapObject = Nothing

End Sub

Release Notes

Initial release in version 11.00.

See Also