Indicates whether any consolidations are currently running or queued for the specified entity, scenario, year, and range of periods. If FindOverlappingConsolidation finds any such consolidations, the consolidations’ types and dimension member labels are returned.
You can avoid executing redundant consolidations by calling FindOverlappingConsolidation before launching a consolidation. |
The information returned by FindOverlappingConsolidation includes several arrays. These arrays have a one-to-one correspondence, and contain one item for each consolidation that matches the specified dimension members.
<HsvCalculate>.FindOverlappingConsolidation lEntity, lParent, lScenario, lYear, lStartPeriod, lEndPeriod, lConsolType, pbstrYear, pbstrScenario, pvarabstrEntity, pvarabstrParent, pvarabstrStartPeriod, pvarabstrEndPeriod, pvaralConsolType, plTotalOverlapRecordsLong (ByVal). The member ID of the lEntity argument’s parent. | |
Long (ByVal). The member ID of the Scenario dimension member. | |
Long (ByVal). The member ID of the first Period dimension member in the range of periods. | |
Long (ByVal). The member ID of the last Period dimension member in the range of periods. | |
Long (ByVal). Identifies the type of consolidation to test for. Pass one of the constants in the HFMConstants type library enumeration tagCONSOLIDATIONTYPE, which is described in Consolidation Type Constants. | |
String. Returns the label of the Year dimension member for the consolidations, or a blank string if no matching consolidations are found. | |
String. Returns the label of the Scenario dimension member for the consolidations, or a blank string if no matching consolidations are found. | |
Variant. Returns an array containing the labels of the consolidations’ Entity dimension members, or an empty variant if no matching consolidations are found. | |
Variant. Returns an array containing the parents of the entities returned by the pvarabstrEntity argument. | |
Variant. Returns an array containing the labels of the first periods in the consolidations’ ranges of periods, or an empty variant if no matching consolidations are found. | |
Variant. Returns an array containing the labels of the last periods in the consolidations’ ranges of periods, or an empty variant if no matching consolidations are found. | |
Variant. Returns an array containing the IDs of the consolidations’ types, or an empty variant if no matching consolidations are found. Consolidation types are represented by the HFMConstants type library enumeration tagCONSOLIDATIONTYPE, which is described in Consolidation Type Constants. | |
Long. Returns a count of the consolidations currently queued or running for the specified dimension members. |