AddByPoint Method

cAreaObj AddByPoint Method

CSi API ETABS 2015

Adds a new area object whose defining points are specified by name.

Namespace: ETABS2015
Assembly: ETABS2015 (in ETABS2015.dll) Version: 15.0.0.0 (15.0.0.0)

Syntax

int AddByPoint(
	int NumberPoints,
	ref string[] Point,
	ref string Name,
	string PropName = "Default",
	string UserName = ""
)

int AddByPoint(
	int NumberPoints,
	ref string[] Point,
	ref string Name,
	string PropName = "Default",
	string UserName = ""
)

Function AddByPoint ( _
	NumberPoints As Integer, _
	ByRef Point As String(), _
	ByRef Name As String, _
	Optional PropName As String = "Default", _
	Optional UserName As String = "" _
) As Integer

Function AddByPoint ( _
	NumberPoints As Integer, _
	ByRef Point As String(), _
	ByRef Name As String, _
	Optional PropName As String = "Default", _
	Optional UserName As String = "" _
) As Integer

int AddByPoint(
	int NumberPoints, 
	array<String^>^% Point, 
	String^% Name, 
	String^ PropName = L"Default", 
	String^ UserName = L""
)

int AddByPoint(
	int NumberPoints, 
	array<String^>^% Point, 
	String^% Name, 
	String^ PropName = L"Default", 
	String^ UserName = L""
)

Parameters

NumberPoints: Type: System Int32
The number of points in the area object.

Point: Type: System String

Name: Type: System String
This is the name that the program ultimately assigns to the area object. If no userName is specified, the program assigns a default name to the area object. If a userName is specified and that name is not used for another area object, the userName is assigned to the area object; otherwise a default name is assigned to the area object.

PropName (Optional): Type: System String
This is Default, None or the name of a defined area property.
If it is Default, the program assigns a default area property to the area object. If it is None, no area property is assigned to the area object. If it is the name of a defined area property, that property is assigned to the area object.

UserName (Optional): Type: System String

Return Value

Returns zero if the area object is successfully added; 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 
   Dim Point() As String 
   Dim Name 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 area object by points 
   Redim Point(3)
   Point(0) = "8"
   Point(1) = "2"
   Point(2) = "65"
   Point(3) = "68"
   ret = SapModel.AreaObj.AddByPoint(4, Point, Name)

'refresh view
   ret = SapModel.View.RefreshView(0, False)

'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 
   Dim Point() As String 
   Dim Name 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 area object by points 
   Redim Point(3)
   Point(0) = "8"
   Point(1) = "2"
   Point(2) = "65"
   Point(3) = "68"
   ret = SapModel.AreaObj.AddByPoint(4, Point, Name)

'refresh view
   ret = SapModel.View.RefreshView(0, False)

'close ETABS
   EtabsObject.ApplicationExit(False)

'clean up variables
   SapModel = Nothing
   EtabsObject = Nothing 

End Sub