GetLoadTemperature Method

cAreaObj GetLoadTemperature Method

CSi API ETABS 2015

Retrieves the temperature load assignments to area objects.

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

Syntax

int GetLoadTemperature(
	string Name,
	ref int NumberItems,
	ref string[] AreaName,
	ref string[] LoadPat,
	ref int[] MyType,
	ref double[] Value,
	ref string[] PatternName,
	eItemType ItemType = eItemType.Objects
)

int GetLoadTemperature(
	string Name,
	ref int NumberItems,
	ref string[] AreaName,
	ref string[] LoadPat,
	ref int[] MyType,
	ref double[] Value,
	ref string[] PatternName,
	eItemType ItemType = eItemType.Objects
)

Function GetLoadTemperature ( _
	Name As String, _
	ByRef NumberItems As Integer, _
	ByRef AreaName As String(), _
	ByRef LoadPat As String(), _
	ByRef MyType As Integer(), _
	ByRef Value As Double(), _
	ByRef PatternName As String(), _
	Optional ItemType As eItemType = eItemType.Objects _
) As Integer

Function GetLoadTemperature ( _
	Name As String, _
	ByRef NumberItems As Integer, _
	ByRef AreaName As String(), _
	ByRef LoadPat As String(), _
	ByRef MyType As Integer(), _
	ByRef Value As Double(), _
	ByRef PatternName As String(), _
	Optional ItemType As eItemType = eItemType.Objects _
) As Integer

int GetLoadTemperature(
	String^ Name, 
	int% NumberItems, 
	array<String^>^% AreaName, 
	array<String^>^% LoadPat, 
	array<int>^% MyType, 
	array<double>^% Value, 
	array<String^>^% PatternName, 
	eItemType ItemType = eItemType::Objects
)

int GetLoadTemperature(
	String^ Name, 
	int% NumberItems, 
	array<String^>^% AreaName, 
	array<String^>^% LoadPat, 
	array<int>^% MyType, 
	array<double>^% Value, 
	array<String^>^% PatternName, 
	eItemType ItemType = eItemType::Objects
)

Parameters

Name: Type: System String
The name of an existing area object or group, depending on the value of the ItemType item.

NumberItems: Type: System Int32
The total number of temperature loads retrieved for the specified area objects.

AreaName: Type: System String
This is an array that includes the name of the area object associated with each temperature load.

LoadPat: Type: System String
This is an array that includes the name of the load pattern associated with each temperature load.

MyType

Type:

System Int32
This is an array that includes either 1 or 3, indicating the type of temperature load.

1 = Temperature
3 = Temperature gradient along local 3 axis

Value: Type: System Double
This is an array that includes the temperature load value. [T] for MyType = 1 and [T/L] for MyType= 3.

PatternName: Type: System String
This is an array that includes the joint pattern name, if any, used to specify the temperature load.

ItemType (Optional)

Type: ETABS2015 eItemType
This is one of the following items in the eItemType enumeration:

Object = 0
Group = 1
SelectedObjects = 2

If this item is Objects, the assignments are retrieved for the area object specified by the Name item.

If this item is Group, the assignments are retrieved for all area objects in the group specified by the Name item.

If this item is SelectedObjects, assignments are retrieved for is made to all selected area objects, and the Name item is ignored.

Return Value

Returns zero if the load assignments are successfully retrieved; otherwise it returns a nonzero value.

Remarks