GetDatabaseUnits

cSapModel GetDatabaseUnits_2 Method

CSi API ETABS 2015

Retrieves the database units for the model. All data is internally stored in the model in these units and converted to the present units as needed.

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

Syntax

C++

Copy to Clipboard Print

int GetDatabaseUnits_2(
	ref eForce forceUnits,
	ref eLength lengthUnits,
	ref eTemperature temperatureUnits
)

int GetDatabaseUnits_2(
	ref eForce forceUnits,
	ref eLength lengthUnits,
	ref eTemperature temperatureUnits
)

Function GetDatabaseUnits_2 ( _
	ByRef forceUnits As eForce, _
	ByRef lengthUnits As eLength, _
	ByRef temperatureUnits As eTemperature _
) As Integer

Function GetDatabaseUnits_2 ( _
	ByRef forceUnits As eForce, _
	ByRef lengthUnits As eLength, _
	ByRef temperatureUnits As eTemperature _
) As Integer

int GetDatabaseUnits_2(
	eForce% forceUnits, 
	eLength% lengthUnits, 
	eTemperature% temperatureUnits
)

int GetDatabaseUnits_2(
	eForce% forceUnits, 
	eLength% lengthUnits, 
	eTemperature% temperatureUnits
)

Parameters

forceUnits: Type: ETABS2015 eForce
A value from the eForce enumeration

lengthUnits: Type: ETABS2015 eLength
A value from the eLength enumeration

temperatureUnits: Type: ETABS2015 eTemperature
A value from the eTemperature enumeration

Return Value

Returns zero if the units are 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 

   '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 database units 
       Dim forceUnits As ETABS2015.eForce
       Dim lengthUnits As ETABS2015.eLength
       Dim temperatureUnits As ETABS2015.eTemperature
       ret = SapModel.GetDatabaseUnits_2(forceUnits, lengthUnits, temperatureUnits)

   'run model (this will create the analysis model)
       ret = SapModel.Analyze.RunAnalysis

   '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 

   '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 database units 
       Dim forceUnits As ETABS2015.eForce
       Dim lengthUnits As ETABS2015.eLength
       Dim temperatureUnits As ETABS2015.eTemperature
       ret = SapModel.GetDatabaseUnits_2(forceUnits, lengthUnits, temperatureUnits)

   'run model (this will create the analysis model)
       ret = SapModel.Analyze.RunAnalysis

   'close ETABS
       EtabsObject.ApplicationExit(False)

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