TM1SubsetElementDisplay

Purpose

Returns information necessary to draw levels, lines and plus/minus boxes corresponding to a subset element displayed in a tree hierarchy.

Definition

Declare Function TM1SubsetElementDisplay
Lib "tm1api.dll" (ByVal hPool As Long, 
ByVal hSubset As Long, ByVal
iElement As Long) As Long

Parameters

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

hSubset is a long. This TM1 value capsule contains a valid handle to the subset. The handle is obtained either by calling TM1SubsetCreateEmpty or by processing a dimension list property with the TM1ObjectList functions.

iElement is a long. This TM1 value capsule contains an index into the subset corresponding to the element that you want to display.

Result

Returns a long. This value capsule contains an encoded character string of information about the display characteristics of an element in a tree structure.

Result (cont.)

Once you have called this function and received the value capsule containing the string, you analyze the contents by passing the results to the following functions:

TM1SubsetElementDisplayLevel

TM1SubsetElementDisplayTee

TM1SubsetElementDisplayEll

TM1SubsetElementDisplayPlus

TM1SubsetElementDisplayMinus

TM1SubsetElementDisplayWeight

TM1SubsetElementDisplayLine

Security

None.

Errors

None.

See Also

Other TM1SubsetElementDisplay functions.