Difference between revisions of "CATable::GetDataByElements"

m (link to CATable)
m (minor mistake)
Line 5: Line 5:
 
Retrieves the value of an input table cell according to «indexPositions», which specify the 1-based position along each index of the table in order.
 
Retrieves the value of an input table cell according to «indexPositions», which specify the 1-based position along each index of the table in order.
  
The parameter specifies the coordinates of a cell in the table, using the position along the index, with position 1 being the first element([[CATable::GetDataByElements]] does the same using index labels).  When the table is one dimensional, indexPositions be a single interger value.  Otherwise, indexPositions must be an array with ''N'' numbers when the table is ''N''-dimensional.
+
The parameter specifies the coordinates of a cell in the table, using the position along the index, with position 1 being the first element([[CATable::GetDataByLabels]] does the same using index labels).  When the table is one dimensional, «indexPositions» be a single interger value.  Otherwise, «indexPositions» must be an array with ''N'' numbers when the table is ''N''-dimensional.
  
 
The order of the dimensions, as they are listed in «indexPositions», is determined by a previous call to [[CATable::SetIndexOrder]].
 
The order of the dimensions, as they are listed in «indexPositions», is determined by a previous call to [[CATable::SetIndexOrder]].

Revision as of 19:08, 30 September 2013

<< Back to CATable

CATable::GetDataByElements(indexPositions)

Retrieves the value of an input table cell according to «indexPositions», which specify the 1-based position along each index of the table in order.

The parameter specifies the coordinates of a cell in the table, using the position along the index, with position 1 being the first element(CATable::GetDataByLabels does the same using index labels). When the table is one dimensional, «indexPositions» be a single interger value. Otherwise, «indexPositions» must be an array with N numbers when the table is N-dimensional.

The order of the dimensions, as they are listed in «indexPositions», is determined by a previous call to CATable::SetIndexOrder.

The return value is the value of the table cell. The manner in which this value is returned is determined by the CATable::RenderingStyle.

When the result table is zero-dimensional (i.e., atomic, not an array), you must use CATable::AtomicValue to access the value.

Examples

In VB

dim editTab as CATable = var2d.DefTable
dim coord(1)   ' Contains two elements, (0) and (1)
coord(0) = 3
coord(1) = 2
editTab.SetIndexOrder( Split("I,J",",") )

ET = editTab.GetDataByElements(coord)
dim resTab as CATable = var2d.ResultTable
resTab.SetIndexOrder( Split("I,J",","))
RT = resultTab.GetDataByElements(coord)
RT1 = var1d.ResultTable.GetDataByElements(4)

Error Codes

24 – “Subscripts must be an array of variants”
25 – “Subscripts cannot be accessed”
26 – “Lower bound of subscript array inaccessible”
27 – “Upper bound of subscript array inaccessible”
28 – “Must specify at least one element in table”
30 – “Position does not exist”

See Also

Comments


You are not allowed to post comments.