SetMasterStory Method

cStory SetMasterStory Method

CSi API ETABS 2015

Sets whether a defined story is a master story

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

Syntax

int SetMasterStory(
	string Name,
	bool IsMasterStory
)

int SetMasterStory(
	string Name,
	bool IsMasterStory
)

Function SetMasterStory ( _
	Name As String, _
	IsMasterStory As Boolean _
) As Integer

Function SetMasterStory ( _
	Name As String, _
	IsMasterStory As Boolean _
) As Integer

int SetMasterStory(
	String^ Name, 
	bool IsMasterStory
)

int SetMasterStory(
	String^ Name, 
	bool IsMasterStory
)

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

Return Value

Returns zero if the value is successfully set, 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 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)

   'unset story as master story
       ret = SapModel.Story.SetMasterStory("Story4", False)

   'check if story is a master story
       ret = SapModel.Story.GetMasterStory("Story4", IsMasterStory)

   'check other stories no longer using Story 4 as master
       ret = SapModel.Story.GetSimilarTo("Story2", IsMasterStory, 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 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)

   'unset story as master story
       ret = SapModel.Story.SetMasterStory("Story4", False)

   'check if story is a master story
       ret = SapModel.Story.GetMasterStory("Story4", IsMasterStory)

   'check other stories no longer using Story 4 as master
       ret = SapModel.Story.GetSimilarTo("Story2", IsMasterStory, SimilarToStory)

   'close ETABS
       EtabsObject.ApplicationExit(False)

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