GetPresentUnits

cSapModel GetPresentUnits_2 Method

CSi API ETABS 2015

Retrieves the units presently specified for the model

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

Syntax

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

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

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

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

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

int GetPresentUnits_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 present units 
       Dim forceUnits As ETABS2015.eForce
       Dim lengthUnits As ETABS2015.eLength
       Dim temperatureUnits As ETABS2015.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

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 ETABS2015.eForce
       Dim lengthUnits As ETABS2015.eLength
       Dim temperatureUnits As ETABS2015.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