SetPresentUnits Method

cSapModel SetPresentUnits Method

CSi API ETABS 2015

Sets the display (present) units.

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

Syntax

int SetPresentUnits(
	eUnits Units
)

int SetPresentUnits(
	eUnits Units
)

Function SetPresentUnits ( _
	Units As eUnits _
) As Integer

Function SetPresentUnits ( _
	Units As eUnits _
) As Integer

int SetPresentUnits(
	eUnits Units
)

int SetPresentUnits(
	eUnits Units
)

Parameters

Units: Type: ETABS2015 eUnits
One of the items in the eUnits enumeration

Return Value

Returns zero if the units are successfully set and nonzero if they are not set.

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()

   'set present units to KN-m
       ret = SapModel.SetPresentUnits(KN_m_C)

   'create steel deck template model
       ret = SapModel.File.NewSteelDeck(4,12,12,4,4,24,24)

   'get present units 
       Dim presentUnits as eUnits
       presentUnits = SapModel.GetPresentUnits()

   '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()

   'set present units to KN-m
       ret = SapModel.SetPresentUnits(KN_m_C)

   'create steel deck template model
       ret = SapModel.File.NewSteelDeck(4,12,12,4,4,24,24)

   'get present units 
       Dim presentUnits as eUnits
       presentUnits = SapModel.GetPresentUnits()

   'close ETABS
       EtabsObject.ApplicationExit(False)

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