GetNameListOnStory Method

cLinkObj GetNameListOnStory Method

CSi API ETABS 2015

Retrieves the names of the defined link objects on a given story.

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

Syntax

int GetNameListOnStory(
	string StoryName,
	ref int NumberNames,
	ref string[] MyName
)

int GetNameListOnStory(
	string StoryName,
	ref int NumberNames,
	ref string[] MyName
)

Function GetNameListOnStory ( _
	StoryName As String, _
	ByRef NumberNames As Integer, _
	ByRef MyName As String() _
) As Integer

Function GetNameListOnStory ( _
	StoryName As String, _
	ByRef NumberNames As Integer, _
	ByRef MyName As String() _
) As Integer

int GetNameListOnStory(
	String^ StoryName, 
	int% NumberNames, 
	array<String^>^% MyName
)

int GetNameListOnStory(
	String^ StoryName, 
	int% NumberNames, 
	array<String^>^% MyName
)

Parameters

StoryName: Type: System String
The name of an existing story.

NumberNames: Type: System Int32
The number of link object names retrieved by the program.

MyName: Type: System String
This is a one-dimensional array of link object names. The MyName array is created as a dynamic, zero-based, array by the API user: Dim MyName() as String
The array is dimensioned to (NumberNames - 1) inside the program, filled with the names, and returned to the API user.

Return Value

Returns zero if the names are successfully retrieved; otherwise it 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 Name As String 
       Dim NumberNames As  Integer 
       Dim MyName() 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", Name)
       ret = SapModel.LinkObj.AddByPoint("1", "5", Name)

   'get link object names
       ret = SapModel.LinkObj.GetNameListOnStory("Story4", NumberNames, MyName)

   '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 Name As String 
       Dim NumberNames As  Integer 
       Dim MyName() 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", Name)
       ret = SapModel.LinkObj.AddByPoint("1", "5", Name)

   'get link object names
       ret = SapModel.LinkObj.GetNameListOnStory("Story4", NumberNames, MyName)

   'close ETABS
       EtabsObject.ApplicationExit(False)

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