Sets the master story that a defined story should be similar to
Namespace: ETABS2015Assembly: ETABS2015 (in ETABS2015.dll) Version: 15.0.0.0 (15.0.0.0)
int SetSimilarTo(
string Name,
string SimilarToStory
)
Function SetSimilarTo ( _
Name As String, _
SimilarToStory As String _
) As Integer
int SetSimilarTo(
String^ Name,
String^ SimilarToStory
)
Parameters
- Name
- Type:
System String
The name of a defined story which is not a master story
- SimilarToStory
- Type:
System String
The name of a defined master story that the requested story should be similar to
Return Value
Returns zero if the value is successfully set,
otherwise returns nonzero.
Public Sub Example()
Dim SapModel As cSapModel
Dim EtabsObject As cOAPI
Dim ret As Integer = -1
Dim IsMasterStory As Boolean
Dim SimilarToStory As String
EtabsObject = CreateObject("CSI.ETABS.API.ETABSObject")
ret = EtabsObject.ApplicationStart()
SapModel = EtabsObject.SapModel
ret = SapModel.InitializeNewModel()
ret = SapModel.File.NewSteelDeck(4,12,12,4,4,24,24)
ret = SapModel.Story.SetMasterStory("Story2", True)
ret = SapModel.Story.SetSimilarTo("Story3", "Story2")
ret = SapModel.Story.GetSimilarTo("Story3", IsMasterStory, SimilarToStory)
EtabsObject.ApplicationExit(False)
SapModel = Nothing
EtabsObject = Nothing
End Sub
Public Sub Example()
Dim SapModel As cSapModel
Dim EtabsObject As cOAPI
Dim ret As Integer = -1
Dim IsMasterStory As Boolean
Dim SimilarToStory 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)
'set story as master story
ret = SapModel.Story.SetMasterStory("Story2", True)
'set story similar to
ret = SapModel.Story.SetSimilarTo("Story3", "Story2")
'check
ret = SapModel.Story.GetSimilarTo("Story3", IsMasterStory, SimilarToStory)
'close ETABS
EtabsObject.ApplicationExit(False)
'clean up variables
SapModel = Nothing
EtabsObject = Nothing
End Sub