AddByPoint Method

cLinkObj AddByPoint Method

CSi API ETABS 2015

Adds a new link object whose end points are specified by name.

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

Syntax

int AddByPoint(
	string Point1,
	string Point2,
	ref string Name,
	bool IsSingleJoint = false,
	string PropName = "Default",
	string UserName = ""
)

int AddByPoint(
	string Point1,
	string Point2,
	ref string Name,
	bool IsSingleJoint = false,
	string PropName = "Default",
	string UserName = ""
)

Function AddByPoint ( _
	Point1 As String, _
	Point2 As String, _
	ByRef Name As String, _
	Optional IsSingleJoint As Boolean = False, _
	Optional PropName As String = "Default", _
	Optional UserName As String = "" _
) As Integer

Function AddByPoint ( _
	Point1 As String, _
	Point2 As String, _
	ByRef Name As String, _
	Optional IsSingleJoint As Boolean = False, _
	Optional PropName As String = "Default", _
	Optional UserName As String = "" _
) As Integer

int AddByPoint(
	String^ Point1, 
	String^ Point2, 
	String^% Name, 
	bool IsSingleJoint = false, 
	String^ PropName = L"Default", 
	String^ UserName = L""
)

int AddByPoint(
	String^ Point1, 
	String^ Point2, 
	String^% Name, 
	bool IsSingleJoint = false, 
	String^ PropName = L"Default", 
	String^ UserName = L""
)

Parameters

Point1: Type: System String
The name of a defined point object at the I-End of the added link object.

Point2: Type: System String
The name of a defined point object at the J-End of the added link object.
This item is ignored if the IsSingleJoint item is True.

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

IsSingleJoint (Optional): Type: System Boolean
This item is True if a one-joint link is added and False if a two-joint link is added.

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

UserName (Optional): Type: System String

Return Value

Returns zero if the link object is successfully added; otherwise it returns a nonzero value.

Remarks

One-joint links are not supported in ETABS.

Examples

C++

Copy to Clipboard Print

Public Sub Example()
       Dim SapModel As cSapModel
       Dim EtabsObject As cOAPI
       Dim ret As Integer = -1 
       Dim Name1 As String 
       Dim Name2 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 link object by points
       ret = SapModel.LinkObj.AddByPoint("2", "4", Name1)
       ret = SapModel.LinkObj.AddByPoint("1", "5", Name2)

   'refresh view
       ret = SapModel.View.RefreshView

   '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 Name1 As String 
       Dim Name2 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 link object by points
       ret = SapModel.LinkObj.AddByPoint("2", "4", Name1)
       ret = SapModel.LinkObj.AddByPoint("1", "5", Name2)

   'refresh view
       ret = SapModel.View.RefreshView

   'close ETABS
       EtabsObject.ApplicationExit(False)

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