Retrieves the code name used for auto wind parameters in Wind-type load patterns.
Namespace: ETABS2015Assembly: ETABS2015 (in ETABS2015.dll) Version: 15.0.0.0 (15.0.0.0)
int GetAutoWindCode(
string Name,
ref string CodeName
)
Function GetAutoWindCode ( _
Name As String, _
ByRef CodeName As String _
) As Integer
int GetAutoWindCode(
String^ Name,
String^% CodeName
)
Parameters
- Name
- Type:
System String
The name of an existing Wind-type load pattern.
- CodeName
- Type: System String
This is either blank or the name code used for the auto wind parameters.
Blank means no auto wind load is specified for the Wind-type load pattern.
Return Value
Returns zero if the code is successfully retrieved; otherwise it returns a nonzero value.
An error is returned if the specified load pattern is not a Wind-type load pattern.
Public Sub Example()
Dim SapModel As cSapModel
Dim EtabsObject As cOAPI
Dim ret As Integer = -1
Dim CodeName As String
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.Add("WIND", LTYPE_WIND)
ret = SapModel.LoadPatterns.GetAutoWindCode("WIND", CodeName)
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 CodeName As String
'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)
'add new load pattern
ret = SapModel.LoadPatterns.Add("WIND", LTYPE_WIND)
'get auto wind code
ret = SapModel.LoadPatterns.GetAutoWindCode("WIND", CodeName)
'close ETABS
EtabsObject.ApplicationExit(False)
'clean up variables
SapModel = Nothing
EtabsObject = Nothing
End Sub