IsConsolidateYTD

Indicates whether a given Scenario dimension member supports year-to-date consolidation.

Note:

A Scenario member’s ConsolidateYTD attribute determines whether the member supports year-to-date consolidation

Syntax

<HsvScenarios>.IsConsolidateYTD lItemID, pbConsolidateYTD

Argument

Description

lItemID

Long (ByVal). The member ID of the Scenario dimension member.

pbConsolidateYTD

Boolean. Indicates whether the member supports year-to-date consolidation. Returns TRUE if the member supports year-to-date consolidation, FALSE if it does not.

Example

The following function indicates whether a given Scenario dimension member supports year-to-date consolidation.

Function isScenYTD(sMemberName As String) As Boolean
Dim lMemId As Long, bYTD As Boolean
Dim cTreeInfo As IHsvTreeInfo, cScenario As HsvScenarios
'm_cMetadata is an HsvMetadata object reference
Set cTreeInfo = m_cMetadata.Scenarios
Set cScenario = m_cMetadata.Scenarios
lMemId = cTreeInfo.GetItemID(sMemberName)
cScenario.IsConsolidateYTD lMemId, bYTD
isScenYTD = bYTD
End Function