TM1ViewArrayConstruct

Purpose

Constructs a two dimensional array of data that can be used to display the data of a view.

When you use TM1ViewArrayConstruct to access a registered view (via the hView parameter), IBM® Cognos® TM1® applies a server lock while the view is calculated.

Definition

Declare Function TM1ViewArrayConstruct
Lib "tm1api.dll" (ByVal hPool As Long, 
ByVal hView As Long) As Long

Parameters

hPool is a long. This TM1 value capsule contains a pool handle. The pool handle is returned by the function TM1ValPoolCreate.

hView is a long. This TM1 value capsule contains 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.

Result

Returns a long integer. The long contains a value capsule. Pass the value capsule to TM1ValBoolGet to retrieve the call result. If the result is a 1, the values in the view are available for retrieval. To extract values from a view, you would typically call functions in this order:

TM1ViewArrayConstruct()

TM1ViewArrayRowsNof()

TM1ViewArrayColumnsNof()

TM1ViewArrayValueGet()

Security

None.

Errors

None.

See Also

TM1ViewArrayValueGet

TM1ViewArrayRowsNof

TM1ViewArrayColumnsNof