Retrieves the self weight multiplier for a specified load pattern.
Namespace: ETABS2015Assembly: ETABS2015 (in ETABS2015.dll) Version: 15.0.0.0 (15.0.0.0)
int GetSelfWTMultiplier(
string Name,
ref double SelfWTMultiplier
)
Function GetSelfWTMultiplier ( _
Name As String, _
ByRef SelfWTMultiplier As Double _
) As Integer
Function GetSelfWTMultiplier ( _
Name As String, _
ByRef SelfWTMultiplier As Double _
) As Integer
int GetSelfWTMultiplier(
String^ Name,
double% SelfWTMultiplier
)
Parameters
- Name
- Type:
System String
The name of an existing load pattern.
- SelfWTMultiplier
- Type: System Double
The self weight multiplier for the specified load pattern.
Return Value
Returns zero if the multiplier is successfully retrieved;
otherwise it returns a nonzero value.
Public Sub Example()
Dim SapModel As cSapModel
Dim EtabsObject As cOAPI
Dim ret As Integer = -1
Dim SelfWTMultiplier As Double
EtabsObject = CreateObject("CSI.ETABS.API.ETABSObject")
ret = EtabsObject.ApplicationStart()
SapModel = EtabsObject.SapModel
ret = SapModel.InitializeNewModel()
ret = SapModel.File.NewSteelDeck(4,12,12,4,4,24,24)
ret = SapModel.LoadPatterns.GetSelfWtMultiplier("DEAD", SelfWTMultiplier)
EtabsObject.ApplicationExit(False)
SapModel = Nothing
EtabsObject = Nothing
End SubPublic Sub Example()
Dim SapModel As cSapModel
Dim EtabsObject As cOAPI
Dim ret As Integer = -1
Dim SelfWTMultiplier As Double
'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 self weight multiplier
ret = SapModel.LoadPatterns.GetSelfWtMultiplier("DEAD", SelfWTMultiplier)
'close ETABS
EtabsObject.ApplicationExit(False)
'clean up variables
SapModel = Nothing
EtabsObject = Nothing
End Sub