cSapModelGetPresentUnits_2 Method

Retrieves the units presently specified for the model

Namespace:  ETABS2016
Assembly:  ETABS2016 (in ETABS2016.dll) Version: 16.0.0.0 (16.0.0.0)
Syntax
Copy
int GetPresentUnits_2(
	ref eForce forceUnits,
	ref eLength lengthUnits,
	ref eTemperature temperatureUnits
)

Parameters

forceUnits
Type: ETABS2016eForce
A value from the eForce enumeration
lengthUnits
Type: ETABS2016eLength
A value from the eLength enumeration
temperatureUnits
Type: ETABS2016eTemperature
A value from the eTemperature enumeration

Return Value

Type: Int32
Returns zero if the units are successfully retrieved, otherwise returns nonzero
Remarks
Examples
VB
Copy
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 present units
       Dim forceUnits As eForce
       Dim lengthUnits As eLength
       Dim temperatureUnits As eTemperature
       ret = SapModel.GetPresentUnits_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
See Also