SetProperty {Link Object}

SetProperty

Syntax

SapObject.SapModel.LinkObj.SetProperty

VB6 Procedure

Function SetProperty(ByVal name As String, ByVal PropName As String, Optional ByVal ItemType As eItemType = Object) As Long

Parameters

Name

The name of an existing link object or group, depending on the value of the ItemType item.

PropName

This is the name of a link property to be assigned to the specified link object(s).

ItemType

This is one of the following items in the eItemType enumeration:

Object = 0

Group = 1

SelectedObjects = 2

If this item is Object, the assignment is made to the link object specified by the Name item.

If this item is Group, the assignment is made to all link objects in the group specified by the Name item.

If this item is SelectedObjects, assignment is made to all selected link objects, and the Name item is ignored.

Remarks

This function assigns a link property to link objects.

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

VBA Example

Sub SetLinkObjectProp()

'dimension variables

Dim SapObject as cOAPI

Dim SapModel As cSapModel

Dim ret As Long

Dim Name 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

'create model from template

ret = SapModel.File.New2DFrame(PortalFrame, 2, 144, 2, 288)

'add link object by points

ret = SapModel.LinkObj.AddByPoint("1", "5", Name)

'set link property

ret = SapModel.LinkObj.SetProperty(Name, "Link1")

'close Sap2000

SapObject.ApplicationExit False

Set SapModel = Nothing

Set SapObject = Nothing

End Sub

Release Notes

Initial release in version 11.00.

See Also

GetProperty

GetPropertyFD

SetPropertyFD