ImportProp Method

cPropFrame ImportProp Method

CSi API ETABS 2015

Imports a frame section property from a property file.

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

Syntax

int ImportProp(
	string Name,
	string MatProp,
	string FileName,
	string PropName,
	int Color = -1,
	string Notes = "",
	string GUID = ""
)

int ImportProp(
	string Name,
	string MatProp,
	string FileName,
	string PropName,
	int Color = -1,
	string Notes = "",
	string GUID = ""
)

Function ImportProp ( _
	Name As String, _
	MatProp As String, _
	FileName As String, _
	PropName As String, _
	Optional Color As Integer = -1, _
	Optional Notes As String = "", _
	Optional GUID As String = "" _
) As Integer

Function ImportProp ( _
	Name As String, _
	MatProp As String, _
	FileName As String, _
	PropName As String, _
	Optional Color As Integer = -1, _
	Optional Notes As String = "", _
	Optional GUID As String = "" _
) As Integer

int ImportProp(
	String^ Name, 
	String^ MatProp, 
	String^ FileName, 
	String^ PropName, 
	int Color = -1, 
	String^ Notes = L"", 
	String^ GUID = L""
)

int ImportProp(
	String^ Name, 
	String^ MatProp, 
	String^ FileName, 
	String^ PropName, 
	int Color = -1, 
	String^ Notes = L"", 
	String^ GUID = L""
)

Parameters

Name: Type: System String
The name of an existing or new frame section property. If this is an existing property, that property is modified; otherwise, a new property is added. This name does not need to be the same as the PropName item.

MatProp: Type: System String
The name of the material property for the section.

FileName: Type: System String
The name of the frame section property file from which to get the frame section property specified by the PropName item.
In most cases you can input just the name of the property file (e.g. "AISC14.xml") and the program will be able to find it. In some cases you may have to input the full path to the property file.

PropName: Type: System String
The name of the frame section property, inside the property file specified by the FileName item, that is to be imported.

Color (Optional): Type: System Int32

Notes (Optional): Type: System String

GUID (Optional): Type: System String
The GUID (global unique identifier), if any, assigned to the section. If this item is input as Default, the program assigns a GUID to the section.

Return Value

Returns zero if the section property is successfully initialized; otherwise it returns a nonzero value.

Remarks

If the property file is not found, or the specified property name is not found in the property file, the section is set to be a general section with default properties.

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)

   'import new frame section property
       ret = SapModel.PropFrame.ImportProp("W18X35", "A992Fy50", "Sections8.pro", "W18X35")

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

   'import new frame section property
       ret = SapModel.PropFrame.ImportProp("W18X35", "A992Fy50", "Sections8.pro", "W18X35")

   'close ETABS
       EtabsObject.ApplicationExit(False)

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