TM1CubeCellSpreadViewArray

Purpose

Spreads data specified in sControl to a range of cells in a view. This function uses row and column pairs to mark the starting location for the spread command.

Definition

Declare Function
 TM1CubeCellSpreadViewArray
Lib "tm1api.dll" (ByVal hPool As Long, 
ByVal hView As Long, ByVal
aCellRange As Long, 
ByVal aCellRef As Long, 
ByVal sControl As Long)
As Long

Parameters

hPool is a valid pool handle obtained with TM1ValPoolCreate.

hView is a handle to a view. A handle to a new view is returned by the function TM1ViewCreate. Handles to existing views are stored in the cube list property TM1CubeViews.

aCellRange is a handle to an array value. This array contains the locations in the view to which your data will be spread. This array can contain either two values or four values. If the array contains two TM1V integer values (column1, row1), the specified cell is used as a starting point for the data spread. The remainder of the range is determined by the sControl argument.

If the array contains four TM1V integer values (column1, row1, column2, row2), the paired coordinates represent the starting and ending cells of the range where the data will be spread.

aCellRef is only used for Relative Proportional Spread and Relative Percent Adjustment. This TM1V contains an IBM® Cognos® TM1® array. The array contains the reference cell's cube handle, and a set of element handles that identifies the cell. To indicate that there is no reference cell, this parameter should be set to TM1ArrayNull() or to an array with size zero.

Parameters (cont.)

aCellRef is the reference cell for aCellRange. Both aCellRef and aCellRange must be single cell ranges. aCellRef may refer to a cell in any cube, but the target cell must be a consolidated cell, and the consolidation must be identical to the one referenced by aCellRange.

sControl is a TM1V containing a string value. This string is the spreading command. For example, S>100.

For a complete list of the TM1 spreading commands, please refer to Spreading control codes.

Result

The function returns a TM1V containing three successful cases:

TM1CubeCellSpreadFunctionOk()

TM1CubeCellSpreadNumericCellSetOk()

TM1CubeCellSpreadStringCellSetOk()

Security

None.

Errors

TM1ErrorDataSpreadFailed

TM1ErrorObjectNotLoaded

TM1ErrorViewNotConstructed

See Also

TM1CubeCellSpread