GetSimilarTo Method

cStory GetSimilarTo Method

CSi API ETABS 2015

Retrieves whether a story is a master story, and if not, which master story it is similar to

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

Syntax

int GetSimilarTo(
	string Name,
	ref bool IsMasterStory,
	ref string SimilarToStory
)

int GetSimilarTo(
	string Name,
	ref bool IsMasterStory,
	ref string SimilarToStory
)

Function GetSimilarTo ( _
	Name As String, _
	ByRef IsMasterStory As Boolean, _
	ByRef SimilarToStory As String _
) As Integer

Function GetSimilarTo ( _
	Name As String, _
	ByRef IsMasterStory As Boolean, _
	ByRef SimilarToStory As String _
) As Integer

int GetSimilarTo(
	String^ Name, 
	bool% IsMasterStory, 
	String^% SimilarToStory
)

int GetSimilarTo(
	String^ Name, 
	bool% IsMasterStory, 
	String^% SimilarToStory
)

Parameters

Name: Type: System String
The name of a defined story

IsMasterStory: Type: System Boolean
True if the story is a master story, False otherwise

SimilarToStory: Type: System String
If IsMasterStory is False then this is the master story that the requested story is similar to.

Return Value

Returns zero if the value is successfully retrieved, otherwise returns nonzero.

Remarks

Examples

C++

Copy to Clipboard Print

Public Sub Example()
       Dim SapModel As cSapModel
       Dim EtabsObject As cOAPI
       Dim ret As Integer = -1 
       Dim MasterStory 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)

   'get story similar data
       ret = SapModel.Story.GetSimilarTo("Story2", MasterStory, SimilarToStory)

   '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 MasterStory 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)

   'get story similar data
       ret = SapModel.Story.GetSimilarTo("Story2", MasterStory, SimilarToStory)

   'close ETABS
       EtabsObject.ApplicationExit(False)

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