GetOverlappingConsolidationInfoAsXML

Indicates whether any consolidations are currently running or queued for the specified cells.

Tip:	You can avoid executing redundant consolidations by calling GetOverlappingConsolidationInfoAsXML before launching a consolidation.

Syntax

<HFMwDataGrid>.GetOverlappingConsolidationInfoAsXML (lRowStart, lRowEnd, lColStart, lColEnd, varalRows, varalCols, sConsolidationType, pvarbstrXML)

Argument	Description
lRowStart	The index (0-based) that identifies the first row of cells to check, or -1 to pass an array of rows to the varalRows argument. Input argument. Long subtype.
lRowEnd	The index (0-based) that identifies the last row of cells to check. Input argument. Long subtype.
lColStart	The index (0-based) that identifies the first column of cells to check, or -1 to pass an array of columns to the varalCols argument. Input argument. Long subtype.
lColEnd	The index (0-based) that identifies the last column of cells to check. Input argument. Long subtype.
varalRows	If -1 is passed to the lRowStart argument, this argument takes an array of indexes that identify the grid rows to check. Input argument.
varalCols	If -1 is passed to the lColStart argument, this argument takes an array of indexes that identify the grid columns to check. Input argument.
sConsolidationType	Identifies the type of consolidation to be run. Pass one of the HFMConstants type library constants listed in Consolidation Type Constants. Input argument. Integer subtype.
pvarbstrXML	Returns an XML string that represents the dimension members and consolidation types of any consolidations that are found. Output argument.

The following table describes the XML string returned by GetOverlappingConsolidationInfoAsXML.

Table 5. GetOverlappingConsolidationInfoAsXML XML String

Element	Description
OVERLAPPEDCONSOLS	Root element; contains one <OVERLAPPEDCONSOL> tag for each consolidation that is found.
OVERLAPPEDCONSOL	Describes the consolidation’s type and dimension members in the tags described in the following rows.
YEAR	The label of the consolidation’s Year dimension member.
SCENARIO	The label of the consolidation’s Scenario dimension member.
ENTITY	The label of the consolidation’s Entity dimension member.
PARENT	The label of the consolidation’s parent entity.
STARTPERIOD	The label of the first period in the consolidation’s range of periods.
ENDPERIOD	The label of the last period in the consolidation’s range of periods.
TYPE	The number that represents the consolidation type. Valid values are represented by the HFMConstants type library enumeration tagCONSOLIDATIONTYPE, which is described in Consolidation Type Constants.

Return Value

Returns an HRESULT that indicates the call’s success or failure.