GetGridSys_2 Method

cGridSys GetGridSys_2 Method

CSi API ETABS 2015

Retrieves the grid system specified by the Name item.

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

Syntax

int GetGridSys_2(
	string Name,
	ref double Xo,
	ref double Yo,
	ref double RZ,
	ref string GridSysType,
	ref int NumXLines,
	ref int NumYLines,
	ref string[] GridLineIDX,
	ref string[] GridLineIDY,
	ref double[] OrdinateX,
	ref double[] OrdinateY,
	ref bool[] VisibleX,
	ref bool[] VisibleY,
	ref string[] BubbleLocX,
	ref string[] BubbleLocY
)

int GetGridSys_2(
	string Name,
	ref double Xo,
	ref double Yo,
	ref double RZ,
	ref string GridSysType,
	ref int NumXLines,
	ref int NumYLines,
	ref string[] GridLineIDX,
	ref string[] GridLineIDY,
	ref double[] OrdinateX,
	ref double[] OrdinateY,
	ref bool[] VisibleX,
	ref bool[] VisibleY,
	ref string[] BubbleLocX,
	ref string[] BubbleLocY
)

Function GetGridSys_2 ( _
	Name As String, _
	ByRef Xo As Double, _
	ByRef Yo As Double, _
	ByRef RZ As Double, _
	ByRef GridSysType As String, _
	ByRef NumXLines As Integer, _
	ByRef NumYLines As Integer, _
	ByRef GridLineIDX As String(), _
	ByRef GridLineIDY As String(), _
	ByRef OrdinateX As Double(), _
	ByRef OrdinateY As Double(), _
	ByRef VisibleX As Boolean(), _
	ByRef VisibleY As Boolean(), _
	ByRef BubbleLocX As String(), _
	ByRef BubbleLocY As String() _
) As Integer

Function GetGridSys_2 ( _
	Name As String, _
	ByRef Xo As Double, _
	ByRef Yo As Double, _
	ByRef RZ As Double, _
	ByRef GridSysType As String, _
	ByRef NumXLines As Integer, _
	ByRef NumYLines As Integer, _
	ByRef GridLineIDX As String(), _
	ByRef GridLineIDY As String(), _
	ByRef OrdinateX As Double(), _
	ByRef OrdinateY As Double(), _
	ByRef VisibleX As Boolean(), _
	ByRef VisibleY As Boolean(), _
	ByRef BubbleLocX As String(), _
	ByRef BubbleLocY As String() _
) As Integer

int GetGridSys_2(
	String^ Name, 
	double% Xo, 
	double% Yo, 
	double% RZ, 
	String^% GridSysType, 
	int% NumXLines, 
	int% NumYLines, 
	array<String^>^% GridLineIDX, 
	array<String^>^% GridLineIDY, 
	array<double>^% OrdinateX, 
	array<double>^% OrdinateY, 
	array<bool>^% VisibleX, 
	array<bool>^% VisibleY, 
	array<String^>^% BubbleLocX, 
	array<String^>^% BubbleLocY
)

int GetGridSys_2(
	String^ Name, 
	double% Xo, 
	double% Yo, 
	double% RZ, 
	String^% GridSysType, 
	int% NumXLines, 
	int% NumYLines, 
	array<String^>^% GridLineIDX, 
	array<String^>^% GridLineIDY, 
	array<double>^% OrdinateX, 
	array<double>^% OrdinateY, 
	array<bool>^% VisibleX, 
	array<bool>^% VisibleY, 
	array<String^>^% BubbleLocX, 
	array<String^>^% BubbleLocY
)

Parameters

Name: Type: System String
The name of an existing grid system.

Xo: Type: System Double
The global X grid of the origin of the grid system. [L]

Yo: Type: System Double
The global Y grid of the origin of the grid system. [L]

RZ: Type: System Double
The rotation of an axis of the new grid system relative to the global grid system is defined as follows: (1) Rotate the grid system about the positive global Z-axis as defined by the RZ item. [deg]

GridSysType: Type: System String

NumXLines: Type: System Int32

NumYLines: Type: System Int32

GridLineIDX: Type: System String

GridLineIDY: Type: System String

OrdinateX: Type: System Double

OrdinateY: Type: System Double

VisibleX: Type: System Boolean

VisibleY: Type: System Boolean

BubbleLocX: Type: System String

BubbleLocY: Type: System String

Return Value

Returns zero if the grid system data is successfully retrieved, otherwise it returns a nonzero value.

Remarks

Examples