@IRDESCENDANTS

Returns the specified member and all its descendants, or all descendants down to a specified generation or level, including descendants of any occurrences of the specified member as a shared member.

Syntax

@IRDESCENDANTS (mbrName[, genLevNum | genLevName])

mbrName Any valid single member name or member combination, or a function that returns a single member or member combination
genLevNum Optional. An integer value that defines the absolute generation or level number down to which to select the members. A positive integer defines a generation number. A value of 0 or a negative integer defines a level number.
genLevName Optional. Level name or generation name down to which to select the members.

Description

This function returns the specified member and either (1) all descendants of the specified member or (2) all descendants down to an optionally specified generation or level. If one or more of the descendants are shared, the result also includes either all descendants of each member being shared or descendants down to the specified generation or level.

You can use this member set function as a parameter of another function, where that parameter is a list of members. In the absence of shared members, @IRDESCENDANTS and @IDESCENDANTS have identical behavior.

Notes

Example

Example 1

Assume a variation of the Sample Basic database such that the Product dimension includes the following members:

Product
   100
     100-10
     100-20
     100-30
   200
     200-10
     200-20
     200-30
     200-40
   Diet
     100 (Shared Member)
     200 (Shared Member)

Diet has two children "100" and "200" instead of "100-10", "200-20" and "300-30". The members "100" and "200" are shared members.

@IRDESCENDANTS(Diet)

Returns the members: Diet, 100, 100-10, 100-20, 100-30, 200, 200-10, 200-20, 200-30, 200-40 (in that order).

Example 2

@IRDESCENDANTS(East)

Returns East, New York, Massachusetts, Florida, Connecticut, and New Hampshire (in that order) and is exactly the same as @IDESCENDANTS(East).

See Also

@RDESCENDANTS
@IDESCENDANTS
@DESCENDANTS
@ISDESC
@ICHILDREN
@ISIBLINGS
@IANCESTORS

©2004 Hyperion Solutions Corporation. All Rights Reserved.
http://www.hyperion.com